https://github.com/stafyniaksacha/poc-metalsmith
https://github.com/stafyniaksacha/poc-metalsmith
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/stafyniaksacha/poc-metalsmith
- Owner: stafyniaksacha
- Created: 2017-05-04T16:06:07.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-12T12:44:27.000Z (about 8 years ago)
- Last Synced: 2025-02-04T19:15:10.411Z (4 months ago)
- Language: CSS
- Size: 2.02 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Playing with metalsmith
`npm install`
> install dependencies
`node index.js --gzip`
> builds src into build/ folder
`node index.js --dev --watch`
> bind a webserver on 8080 with livereload and watch enabled
`DEBUG=* node index.js --dev --watch --open`
> bind a webserver on 8080 with livereload, open a browser and turn on debug messages
### Usefull links
- [https://www.npmjs.com/package/metalsmith](https://www.npmjs.com/package/metalsmith)
- [https://github.com/metalsmith/awesome-metalsmith](https://github.com/metalsmith/awesome-metalsmith)
- [https://www.npmjs.com/package/metalsmith-ancestry](https://www.npmjs.com/package/metalsmith-ancestry)
- [http://handlebarsjs.com/](http://handlebarsjs.com/)
### todo
- [x] compile markdown
- [x] compile sass
- [x] custom layout
- [x] livereload
- [x] auto tree (reference the next, previous, parent and all children of a particular resource)
- [x] find a way to get sdk-exemples/api-reference working (with tabs / custom template / ...)
- [ ] ~multi version capability ([we can use multi-language plugin](https://github.com/doup/metalsmith-multi-language))~
- [x] generate table of content ~([maybe this ?](https://github.com/majodev/metalsmith-headings-identifier))~
- [ ] ~client-side search [with lunr](https://github.com/CMClay/metalsmith-lunr)~
- [x] try a [broken link checker](https://github.com/gchallen/code.metalsmith-linkcheck)
- [x] try [discus](https://github.com/vitaliy-bobrov/metalsmith-disqus)
- [ ] ~try content [fingerprint](https://github.com/christophercliff/metalsmith-fingerprint)~