xmark-docsite-starter

Simple Docsite Powered by Xmark.

What is This For?

Markdown is awesome when building content dense websites, but markdown itsself is too simple, what about bring some extensions to it?

xmark-docsite-starter is here to help! xmark-docsite-starter is the go to solution if you want to build your doc site with Markdown.

What's Included?

xmark-docsite-starter is a typical gatsby application template, it's powered by following packages

Enable login

If you want to enable login feature, the starter needs some environment variables to work, which are stored in the .env file in the project root directory:

GATSBY_DID_CONNECT_APP_DID="your app did"
GATSBY_DID_CONNECT_SERVICE="https://connect.wallet.arcblockio.cn"
GATSBY_DID_CONNECT_AUTH_ACTION="profile"
GATSBY_DID_CONNECT_API_PREFIX="/api/login/agent"

Requirements?

Here are the knowledge requirements to get you up to speed when using this starter blocklet:

  • Basic usage of npm
  • Basic knowledge of markdown

And to get the starter blocklet up and running on first try, you should:

  • A handy command line terminal
  • Install latest version of forge-cli: npm install -g @arcblock/forge-cli

Besides, if you enabled the login, you need to have ABT Wallet installed to try out the application after bootstrapping.

LICENSE

Copyright 2018-2020 ArcBlock

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.