https://github.com/samuelhorn/jamdocs

The ultimate staic generated documentation theme for the JAM-stack. Highly cusomizable, based on Gridsome, ready to deploy to Netlify in one click.
https://github.com/samuelhorn/jamdocs

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/samuelhorn/jamdocs
• Owner: samuelhorn
• License: mit
• Created: 2019-06-26T11:39:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T20:20:31.000Z (about 2 years ago)
• Last Synced: 2024-08-01T13:39:03.809Z (7 months ago)
• Language: Vue
• Size: 1.39 MB
• Stars: 219
• Watchers: 5
• Forks: 92
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Netlify Status](https://api.netlify.com/api/v1/badges/de44d168-eb1d-47a5-8731-d77bb40af7c8/deploy-status)](https://app.netlify.com/sites/jamdocs/deploys)

# ![Jamdocs](https://github.com/samuelhorn/jamdocs/blob/master/src/assets/img/logo-dark.svg)

The ultimate static generated documentation theme for the JAM-stack. Highly customizable, based on Gridsome, ready to deploy to Netlify in one click. [DEMO](https://jamdocs.samuelhorn.com/)

_Beware, Jamdocs is still in heavy development and will probably change 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](https://github.com/samuelhorn/jamdocs/blob/master/src/assets/img/pagespeed.png)

## Local installation for development

1. `git clone https://github.com/samuelhorn/jamdocs project-name`.

2. `cd project-name`

3. `gridsome develop`.

## Deploy to Netlify

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/samuelhorn/jamdocs)

## Import to Forestry CMS

[![](https://assets.forestry.io/import-to-forestryK.svg)](https://app.forestry.io/quick-start?repo=samuelhorn/jamdocs&engine=other "Import to Forestry")

This project has been pre-configured to work with [Forestry](https://forestry.io). Any changes you make in Forestry will be commited back to your repo. ✨

![Forestry documentation in JAMdocs](static/screenshor-forestry-preview.png)

## Setup & configuration

See the [demo](https://jamdocs.samuelhorn.com/), 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](https://www.netlify.com/) team for making an awesome all in one hosting soluiton for the JAM-stack.

* Creds to the [Gridsome](https://gridsome.org/) team for developing a great foundation to build static sites.

* Creds to [Evan You](https://twitter.com/youyuxi) for making [Vue](https://vuejs.org/).

* Creds to [Cole Bemis](https://twitter.com/colebemis) for making [feathericons](https://feathericons.com/), my favourite icon set.

* Creds to [Egoist](https://github.com/egoist), who's not that egoistic. Because he made [vue-feather-icons](https://github.com/egoist/vue-feather-icons).

* Creds to [Forestry](https://forestry.io/) for finalizing the Forestry configuration and writing about it in the docs, adding their great headless CMS to the mix.

## License

[MIT](https://github.com/samuelhorn/jamdocs/blob/master/LICENSE)

## 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.