https://github.com/wraith13/writing
writing is a markdown rendering system for documents and slides.
https://github.com/wraith13/writing
markdown
Last synced: over 1 year ago
JSON representation
writing is a markdown rendering system for documents and slides.
- Host: GitHub
- URL: https://github.com/wraith13/writing
- Owner: wraith13
- License: bsl-1.0
- Created: 2018-02-05T17:52:44.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-15T14:56:36.000Z (over 4 years ago)
- Last Synced: 2025-04-05T20:02:53.385Z (over 1 year ago)
- Topics: markdown
- Language: JavaScript
- Homepage:
- Size: 3.93 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE_1_0.txt
Awesome Lists containing this project
README
# writing README
This markdown display URL: https://wraith13.github.io/writing/?@README.md
`writing` is a markdown rendering system.
- live site:
- GitHub:
## feature
- ✅ Documents can be displayed using [marked](https://github.com/markedjs/marked), [commonmark](https://github.com/commonmark/commonmark.js), [markdown-it](https://github.com/markdown-it/markdown-it) rendering engines.
- ✅ Slides can be displayed using [remark](https://github.com/gnab/remark), [reveal](https://github.com/hakimel/reveal.js/) rendering engines.
- ✅ [External markdown and instant display possible](https://wraith13.github.io/writing/?@README.md#play-now).
- ✅ Supports mathjax, [plantuml](https://wraith13.github.io/writing/?@demo/plantuml.md), [mermaid](https://wraith13.github.io/writing/?@demo/mermaid.md), [twitter](https://wraith13.github.io/writing/?@demo/twitter.md), google analytics.
## as demo
This README can be displayed as document or slide.
- [document(marked)](https://wraith13.github.io/writing/?marked&@README.md)
- [document(commonmark)](https://wraith13.github.io/writing/?commonmark&@README.md)
- [document(markdown-it)](https://wraith13.github.io/writing/?markdown-it&@README.md)
- [slide(remark)](https://wraith13.github.io/writing/?remark&@README.md)
- [slide(reveal)](https://wraith13.github.io/writing/?reveal&@README.md)
see [others demos](https://wraith13.github.io/writing/?@demo/index.md).
## play now!
- [new document/slide](https://wraith13.github.io/writing/?edit&text:)
## usage
1. Fork [this repository](https://github.com/wraith13/writing/) on GitHub.
1. Edit `./writing.config.json`, commit, and push.
1. Go `Settings`(→`Options`)→`GitHub Pages`, select `master branch` from drop down list, and click `Save`.
For details, see [writing usage](usage.md).
## end of document
- [back to writing index](./index.md)