This is a VuePress documentation application that leverages GitHub as the repository of documentation. The repository is currently hosted in the Zumasys GitHub and the app is available at Zumasys Docs. The application itself is built and deployed as a static site hosted on Azure Storage via a GitHub action.
├── site
│ ├── .vuepress
│ │ ├── components
│ │ ├── dist
│ │ ├── public
│ │ ├── styles
│ │ │ ├── index.styl
│ │ │ └── palette.styl
│ │ ├── theme
│ │ │ ├── components
│ │ │ ├── layouts
│ │ │ └── index.js
│ │ ├── config.js
│ │ ├── enhanceApp.js
│ ├── pos-connect (POS Connect docs)
│ ├── rover (Rover docs)
│ ├── smartsuite (SmartSuite docs)
│ ├── README.md (The home page of the docs)
│ └── package.json
└── README.md (You are here!)
To run the application locally:
You will need to have Node.js & npm installed. You'll also need Git.
-
git clone https://github.com/zumasys/docs.git -
cd docs(or whatever name you used for your git clone) -
cd site -
npm i(Not necessary on subsequent builds) -
To enable all features you'll need to set up environment variables. Create
.env(for production) and.env.development(for development) files in thesitefolder. Use the.env.skelfile as your baseline (for both production and development).- Optionally, if you want the Vssue plugin to work you'll have to populate the following
.envvariables in the file from step 5.
cd site && code .env# Environment Variables VUE_APP_GITHUB_CLIENT_ID=MyClientKey VUE_APP_GITHUB_CLIENT_SECRET=MySecretKey
- Optionally, if you want the Vssue plugin to work you'll have to populate the following
-
npm run dev -
When compilation completes you should see the following message
success [12:25:41] Build 59cc58 finished in 75022 ms!
VuePress dev server listening at http://localhost:8080/ -
Open localhost:8080 in your browser.
- Migrate to VuePress 2
- Review Plugins (related to migration)
- Check out more on awesome-vuepress
- Update 404 page to have featured content