The documentation in this repository site is meant to provide specifications and implementation details that will be useful to third party developers or contributors to the main repository.
You're going to need:
git clone https://github.com/YOURUSERNAME/chain-docs.git
cd chain-docs
npm
npm run docs:dev
You can now see the docs at http://localhost:8080.
/docs/getting-started/
/docs/.vuepress/config.js
sidebar
and the ordering
under vuepress-plugin-export
in pluginsmodule.exports = {
...,
themeConfig: {
...,
sidebar: {
'/getting-started/': [
'',
...,
+ '[Add_Your_New_File_Name_Here]'
...
]
}
},
...,
plugins: [
['vuepress-plugin-export',
{
sorter: function(a,b){
var ordering = {
'Home': 0,
...,
+ '[Add_Your_New_File_Name_Here]': [Add_The_Number_You_Want_The_Page_Be_Ordered]
...,
};
...
}
}
]
]
}
Go to chain-docs/docs
, then run:
vuepress export
PDF styling config in /docs/.vuepress/config.js
, you can refer to Puppeteer doc for the complete page API when generating PDF.
module.exports = {
plugins: [
['vuepress-plugin-export',
{
page: { // Puppeteer.page.pdf([options])
format: 'A4',
printBackground: true,
margin: {
top: 60,
left: 20,
right: 20,
bottom: 60
}
},
sorter: function(a,b){
...,
}
}
]
]
}
a PDF version of the site will be generated under the /docs
path.
git remote show origin
git commit -a -m "YOUR MESSAGE"
git push
./deploy.sh
You should see your updates on http://yourusermame.github.io/chain-docs.