Skip to content
This repository has been archived by the owner on Jun 1, 2023. It is now read-only.

Latest commit

 

History

History
21 lines (13 loc) · 1.16 KB

README.md

File metadata and controls

21 lines (13 loc) · 1.16 KB

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 git@github.com: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.