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 .
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 installoryarn install - Run the dev server which will create the site and update automatically when you make changes:
yarn devornpm run dev - Go to
http://localhost:8080/in your browser to view the site.
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.