{"repo":"oasisprotocol/docs","free":true,"listed":false,"github":"https://github.com/oasisprotocol/docs","clone":"git clone https://github.com/oasisprotocol/docs.git","description":"Official documentation for the Oasis Network.","language":"TypeScript","stars":15,"topics":["blockchain","crypto","docs","documentation","docusaurus","oasis","markdown","network"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"Oasis Docs This repository contains Oasis Docs deployed at . They are built using Docusaurus 2, a modern static website generator. Installation Install Node packages with: Checkout all Git submodules with: Local Development To start the local development server, use: This command will start a local development server. Open your browser at to load the site. Most changes will be reflected live without having to restart the server. Build To generate the static site, use: This will generate the static content in the build directory. Its contents can be served using any static content hosting service. Deployment Docs will be automatically re-generated and re-deployed once a pull request is merged into the main branch. Broken Link Checker Docusaurus already checks all internal links when running yarn build . To also check all external links using a local Oasis Docs instance, do the following: 1. Specify URL env variable and generate the static site: 2. Serve the static site locally: 3. Run broken link checker in a new terminal with: NOTE: Some external URLs appear to be receiving wrong 200-ish HTTP code despite opening correctly in the browser. Exclude those links manually from the broken link checker in package.json . Guidelines for writing Oasis docs Documentation structure docs folder contains markdown files of the documentation. Each subfolder represents a documentation part (general, node, build, paratime, core etc.). Each markdown file inside a part corresponds to a chapter (","default_branch":null,"files":null,"tree":[],"storefront":"/r/oasisprotocol","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/oasisprotocol/docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}