Skip to content

csmblair/docs.rocketpool.net

 
 

Repository files navigation

Documentation Hub

Rocket Pool Documentation Hub - Features Whitepaper, FAQs, Technical Docs, Guides and more. Is written in Vuepress + has emojis and will be built out over the coming months.

We welcome all contributions! Please refer to our contribution guidelines .

Local Testing

If you want to test this locally, follow the next few steps:

  • Clone this repo eg: git clone [email protected]:rocket-pool/docs.rocketpool.net.git ./rpdocs
  • Move into the directory: cd rpdocs
  • Install dependencies using: npm install or yarn install
  • Run the dev server which will create the site and update automatically when you make changes: yarn dev or npm run dev
  • Go to http://localhost:8080/ in your browser to view the site.

Project Structure

Files under /.vuepress include components, style and configs.

To add new pages and have them appear in the side menu, add the links to the sidebar property in the /.vuepress/config.js file for them to appear.

About

Rocket Pool Documentation & Guide Hub

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 77.1%
  • Stylus 12.1%
  • Vue 8.3%
  • Dockerfile 2.5%