unix / Simpler Paper
Licence: mit
elegant document generation tool.
Stars: ✭ 151
Programming Languages
typescript
32286 projects
Projects that are alternatives of or similar to Simpler Paper
Graphdoc
Static page generator for documenting GraphQL Schema
Stars: ✭ 1,218 (+706.62%)
Mutual labels: documentation, documentation-tool
Jekyll Rtd Theme
Just another documentation theme compatible with GitHub Pages
Stars: ✭ 92 (-39.07%)
Mutual labels: documentation, documentation-tool
Drf Autodocs
Ultimately automated DRF documentation rendering(UNMAINTAINED)
Stars: ✭ 82 (-45.7%)
Mutual labels: documentation, documentation-tool
Grav Skeleton Rtfm Site
Grav RTFM Skeleton
Stars: ✭ 74 (-50.99%)
Mutual labels: documentation, documentation-tool
Lurker
📖 The ultimate tool for documenting and testing APIs in Rails
Stars: ✭ 120 (-20.53%)
Mutual labels: documentation, documentation-tool
Zeal
Offline documentation browser inspired by Dash
Stars: ✭ 9,164 (+5968.87%)
Mutual labels: documentation, documentation-tool
Docpht
With DocPHT you can take notes and quickly document anything and without the use of any database.
Stars: ✭ 90 (-40.4%)
Mutual labels: documentation, documentation-tool
App
Fast and searchable Ruby docs
Stars: ✭ 47 (-68.87%)
Mutual labels: documentation, documentation-tool
Catalog
Create living style guides using Markdown or React
Stars: ✭ 1,527 (+911.26%)
Mutual labels: documentation, documentation-tool
Pasdoc
Documentation tool for ObjectPascal (Free Pascal, Lazarus, Delphi) source code
Stars: ✭ 110 (-27.15%)
Mutual labels: documentation, documentation-tool
Peach
Peach is a web server for multi-language, real-time synchronization and searchable documentation.
Stars: ✭ 1,166 (+672.19%)
Mutual labels: documentation, documentation-tool
Documentalist
📝 A sort-of-static site generator optimized for living documentation of software projects
Stars: ✭ 130 (-13.91%)
Mutual labels: documentation, documentation-tool
Awesome Readme
A guide to writing an Awesome README. Read the full article in Towards Data Science.
Stars: ✭ 65 (-56.95%)
Mutual labels: documentation, documentation-tool
Jsdoc To Markdown
Generate markdown documentation from jsdoc-annotated javascript
Stars: ✭ 1,199 (+694.04%)
Mutual labels: documentation, documentation-tool
Vuesence Book
Minimalistic Vue.js based documentation system component
Stars: ✭ 48 (-68.21%)
Mutual labels: documentation, documentation-tool
Community
Modern Confluence alternative designed for internal & external docs, built with Golang + EmberJS
Stars: ✭ 1,286 (+751.66%)
Mutual labels: documentation, documentation-tool
Markdown Guide
The comprehensive Markdown reference guide.
Stars: ✭ 835 (+452.98%)
Mutual labels: documentation, documentation-tool
Pdoc
API Documentation for Python Projects
Stars: ✭ 853 (+464.9%)
Mutual labels: documentation, documentation-tool
Naturaldocs
Natural Docs source code documentation system
Stars: ✭ 106 (-29.8%)
Mutual labels: documentation, documentation-tool
Gdscript Docs Maker
Create documentation and class references from your Godot GDScript code
Stars: ✭ 121 (-19.87%)
Mutual labels: documentation, documentation-tool
elegant document generation tool. preview.
quickly build and deploy markdown files with a few commands.
Guide
Feature
- Agility. just one script(only ~3kb gzipped), no framework.
- Easy. just one command.
- Lazy load.
- Auto compatible mobile phone.
- More themes.
Getting Started
- Install:
npm i -g simpler-paper
- Init:
paper init
. To create the document folder or generate the config file in existing folder. - Add markdown files in document folder.
- Create a folder named "assets" to store the images if needed.🤔🤔
- Add a munber prefix connected by '_' to sort the document or folder. (e.g. 1_firstDoc.md)
- Hierarchical directory generated by the documents folder.
- Build:
paper build
. If you want to preview, runpaper server
. - Deploy:
paper deploy
. Deploy a Git repository to GitHub. Remember to set to GitHub pages.
Configuration Details
You can create a paper.config.json
file in the document directory.
Run
paper init
can quickly createpaper.config.json
// paper.config.json
{
// document the alias, the value will be displayed after compilation, default: null
"alias": {
"quickstart": "Getting Started",
...
},
// document title, default: "simpler paper"
"title": "",
// back to top button, default: true
"backToTop": true,
// document page path, default: "/"
"docPath": "/",
// loading indicator, default: true
"indicator": true
}
LICENSE
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].