https://github.com/topl/knowledge-base

Central repository for documentation and code to build on the Topl blockchain.
https://github.com/topl/knowledge-base

Last synced: about 4 hours ago
JSON representation

Central repository for documentation and code to build on the Topl blockchain.

• Host: GitHub
• URL: https://github.com/topl/knowledge-base
• Owner: Topl
• License: mpl-2.0
• Created: 2022-09-08T14:37:47.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T18:52:57.000Z (3 months ago)
• Last Synced: 2024-07-30T01:07:02.890Z (3 months ago)
• Language: CSS
• Homepage: https://docs.apparatusnetwork.xyz/
• Size: 7.33 MB
• Stars: 1
• Watchers: 10
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog Posts/welcome-to-the-topl-knowledgebase.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Apparatus' Knowledge Base

The central repository for documentation and code examples to build on the Apparatus blockchain.

# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), 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= 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.