Skip to content

aelf-docs provides guidelines, documents and API references for developers building dApps on aelf blockchain.

Notifications You must be signed in to change notification settings

AElfProject/aelf-docs

 
 

Repository files navigation

Website

This website is built using Docusaurus, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Generate search-only api key

curl 'https://typesense.test.aelf.dev/keys' \
  -X POST \
  -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{"description":"Search-only aelf-docs key.","actions": ["documents:search"], "collections": ["aelf-docs"]}'

About

aelf-docs provides guidelines, documents and API references for developers building dApps on aelf blockchain.

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages