{"repo":"ObolNetwork/obol-docs","free":true,"listed":false,"github":"https://github.com/ObolNetwork/obol-docs","clone":"git clone https://github.com/ObolNetwork/obol-docs.git","description":"A docs site for Distributed Validator Technology and the Obol Network","language":"MDX","stars":27,"topics":["ethereum","obol","docusaurus","distributed-validator","documentation"],"license":null,"category":"docs-static-sites","readme_excerpt":"Obol Network This repo intends to serve as a documentation site for the Obol Network. Quickstart This website is built using Docusaurus 2, a modern static website generator. Installation Local Development 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 This command generates static content into the build directory and can be served using any static contents hosting service. Deployment This repo is configured with Github Actions to deploy the built site to github pages. Committing or merging to master will update the production documentation site. Versioning Docusaurus can manage multiple versions of your docs. Create a docs version Release a version v0.5.0 of your project: Control/Command+F the /docs/ folder for the current version, and update all references to the upcoming version. Now you are ready to create the next version by running the following command. The docs folder is copied into versioned docs/version-v0.5.0 and versions.json is created. Your docs now have 2 versions: - v0.5.0 at http://localhost:3000/docs/ for the version v0.5.0 docs - current at http://localhost:3000/docs/next/ for the upcoming, unreleased docs Now push this to a branch and merge to main to release this version update publicly. Add a Version Dropdown To navigate seamlessly across versions, add a version dropdown. Modify the docusaurus.config.js file: The docs version dropdown appears in your","default_branch":null,"files":null,"tree":[],"storefront":"/r/ObolNetwork","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ObolNetwork/obol-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."}