Skip to content
Open-source compliance policies.
Vue CSS JavaScript
Branch: master
Clone or download
Pull request Compare This branch is 10 commits ahead of allanwhite:master.
Latest commit ee84fa2 Nov 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.forestry
.github Create FUNDING.yml Oct 15, 2019
data Config, styling Oct 30, 2019
docs
src Repo link update Oct 30, 2019
static Repo link update Oct 30, 2019
.gitignore Prepared for Algolia Jul 3, 2019
LICENSE first commit Jun 26, 2019
README.md Readme updates Oct 22, 2019
gridsome.config.js
gridsome.server.js Bumped Gridsome version Oct 15, 2019
netlify.toml Added netlify.toml Oct 15, 2019
package.json
yarn.lock Fixed incorrect Inter font package Oct 30, 2019

README.md

Netlify Status

Jamdocs

The ultimate static generated documentation theme for the JAM-stack. Highly customizable, based on Gridsome, ready to deploy to Netlify in one click. DEMO

Beware, Jamdocs is still in heavy development and will probably cahnge a lot in the near future. And the docs for it is still not completed.

Fast by default

Jamdocs is optimized to be as fast as possible, right now generating 100/100/100/100 score in Google Lighthouse. And 100/100 score in Google Page Speed Insights.

100/100/100/100 Lighthouse scores

Local installation for development

  1. git clone https://github.com/samuelhorn/jamdocs project-name.
  2. cd project-name
  3. gridsome develop.

Deploy a copy to netlify

Deploy to Netlify

Setup & configuration

See the demo, which is also the documentation, obviously!

Todos

  1. Improve the actual documentation for Jamdocs, in Jamdocs :)
  2. Build the homepage better, dividing stuff into components and so on.
  3. Implement Algolia search.
  4. Add a link to this repository from the demo.

Credits

  • Creds to the Netlify team for making an awesome all in one hosting soluiton for the JAM-stack.
  • Creds to the Gridsome team for developing a great foundation to build static sites.
  • Creds to Evan You for making Vue.
  • Creds to Cole Bemis for making feathericons, my favourite icon set.
  • Creds to Egoist, who's not that egoistic. Because he made vue-feather-icons.

License

MIT

Finally

Enjoy Jamdocs, and if you like and use this project commercially, please consider sponsoring on Github since I have put a lot of spare time into this.

You can’t perform that action at this time.