{"id":13990867,"url":"https://github.com/unix/simpler-paper","last_synced_at":"2025-03-21T11:31:17.400Z","repository":{"id":57361394,"uuid":"109565521","full_name":"unix/simpler-paper","owner":"unix","description":"elegant document generation tool.","archived":false,"fork":false,"pushed_at":"2018-02-12T03:52:35.000Z","size":789,"stargazers_count":148,"open_issues_count":0,"forks_count":17,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-10T18:11:22.610Z","etag":null,"topics":["doc-gen","documentation","documentation-tool","markdown-blog","markdown-viewer"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-05T09:13:27.000Z","updated_at":"2023-07-27T03:49:04.000Z","dependencies_parsed_at":"2022-09-26T16:40:57.492Z","dependency_job_id":null,"html_url":"https://github.com/unix/simpler-paper","commit_stats":null,"previous_names":["dhyanachina/simpler-paper"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unix%2Fsimpler-paper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unix%2Fsimpler-paper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unix%2Fsimpler-paper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unix%2Fsimpler-paper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unix","download_url":"https://codeload.github.com/unix/simpler-paper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244135894,"owners_count":20403797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["doc-gen","documentation","documentation-tool","markdown-blog","markdown-viewer"],"created_at":"2024-08-09T13:03:26.058Z","updated_at":"2025-03-21T11:31:16.915Z","avatar_url":"https://github.com/unix.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\n\u003cp align=\"center\" height=\"300\"\u003e\n\u003cimg src=\"https://github.com/DhyanaChina/simpler-paper/blob/master/logo.png\" align=\"center\"\u003e\n\u003c/p\u003e\n\n\u003cp align=center\u003e\n\u003ca target=\"_blank\" href=\"https://www.npmjs.com/package/simpler-paper\" title=\"NPM version\"\u003e\u003cimg src=\"https://img.shields.io/github/package-json/v/DhyanaChina/simpler-paper.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca target=\"_blank\" href=\"http://nodejs.org/download/\" title=\"Node version\"\u003e\u003cimg src=\"https://img.shields.io/badge/node.js-%3E=_6.0-green.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca target=\"_blank\" href=\"https://opensource.org/licenses/MIT\" title=\"License: MIT\"\u003e\u003cimg src=\"https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca target=\"_blank\" href=\"https://travis-ci.org/DhyanaChina/simpler-paper\" title=\"Build Status\"\u003e\u003cimg src=\"https://img.shields.io/travis/DhyanaChina/simpler-paper/master.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca target=\"_blank\" href=\"https://www.npmjs.com/package/simpler-paper\" title=\"Downloads\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/simpler-paper.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003e elegant document generation tool. [preview](http://paper.wittsay.cc/).\n\n\u003e quickly build and deploy markdown files with a few commands.    \n\n## Guide  \n- [Feature](#feature)  \n- [Getting Started](#getting-started)  \n- [Configuration Details](#configuration-details)  \n- [Documentation](http://paper.wittsay.cc/)\n- [LICENSE](#license)  \n- [中文](README_CN.md)\n\n### Feature  \n- Agility. just one script(only ~3kb gzipped), no framework.  \n- Easy. just one command.  \n- Lazy load.  \n- Auto compatible mobile phone.  \n- [More themes](https://github.com/DhyanaChina/simpler-paper-themes).\n\n### Getting Started  \n1. Install: `npm i -g simpler-paper`  \n2. Init: `paper init` . To create the document folder or generate the config file in existing folder.  \n3. Add markdown files in document folder.   \n    - Create a folder named \"assets\" to store the images if needed.🤔🤔  \n    - Add a munber prefix connected by '_' to sort the document or folder. (e.g. 1_firstDoc.md)  \n    - Hierarchical directory generated by the documents folder.  \n4. Build: `paper build` . If you want to preview, run `paper server` .  \n5. Deploy: `paper deploy` . Deploy a Git repository to GitHub.\nRemember to [set](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#enabling-github-pages-to-publish-your-site-from-master-or-gh-pages) to GitHub pages.\n\n### Configuration Details\nYou can create a `paper.config.json` file in the document directory.\n\n\u003e Run `paper init` can quickly create `paper.config.json`\n\n```typescript\n// paper.config.json\n{\n  // document the alias, the value will be displayed after compilation, default: null\n  \"alias\": {\n    \"quickstart\": \"Getting Started\",\n    ...\n  },\n\n  // document title, default: \"simpler paper\"\n  \"title\": \"\",\n\n  // back to top button, default: true\n  \"backToTop\": true,\n\n  // document page path, default: \"/\"\n  \"docPath\": \"/\",\n\n  // loading indicator, default: true\n  \"indicator\": true\n}\n```  \n\n\n### LICENSE\n\n[**MIT**](LICENSE)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funix%2Fsimpler-paper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funix%2Fsimpler-paper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funix%2Fsimpler-paper/lists"}