{"id":21840269,"url":"https://github.com/zapier/litdoc","last_synced_at":"2025-06-19T08:03:37.761Z","repository":{"id":143886497,"uuid":"64567535","full_name":"zapier/litdoc","owner":"zapier","description":":triangular_ruler: A simple Markdown-based 3-column documentation builder.","archived":false,"fork":false,"pushed_at":"2017-03-16T18:56:30.000Z","size":41,"stargazers_count":19,"open_issues_count":0,"forks_count":3,"subscribers_count":62,"default_branch":"gh-pages","last_synced_at":"2025-02-27T10:47:55.412Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://litdoc.org","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zapier.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-30T23:02:09.000Z","updated_at":"2024-05-15T13:15:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"3f40c5ac-543c-47fa-8e45-39f9d816e638","html_url":"https://github.com/zapier/litdoc","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapier%2Flitdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapier%2Flitdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapier%2Flitdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zapier%2Flitdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zapier","download_url":"https://codeload.github.com/zapier/litdoc/tar.gz/refs/heads/gh-pages","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244822897,"owners_count":20516191,"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":[],"created_at":"2024-11-27T21:25:27.646Z","updated_at":"2025-03-21T15:34:08.192Z","avatar_url":"https://github.com/zapier.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Introduction\n\n`litdoc` is a simple 3 column documentation generator. The most common use case is a single `README.md`. This file itself is a demo:\n\n* [View original Markdown README.md.](https://github.com/zapier/litdoc/blob/gh-pages/README.md)\n* [View generated HTML documentation.](http://litdoc.org/)\n\n\n## Installation \u0026 Usage\n\nThere are two ways to use `litdoc`, locally and globally.\n\n\n### Local Installation \u0026 Usage\n\nIf you only need `litdoc` for your current project, we recommend a local installation via `npm`.\n\n```bash\n$ npm install litdoc --save-dev\n```\n\nYou can use it as a CLI tool.\n\n```bash\n$ ./node_modules/.bin/litdoc input.md output.html\n```\n\nOr you can use it directly in your application, generating the HTML inline.\n\n```js\nvar litdoc = require('litdoc');\n\n// generate the HTML inline\nvar documentationHtml = litdoc({\n  markdown: '## Hello!\\n\\nThis is a sample doc.\\n\\n' +\n            '```js\\nvar hello = \"world\"\\n```'\n});\n```\n\nOr, you can optionally read/write to specific paths.\n\n```js\nvar litdoc = require('litdoc');\nvar path = require('path');\n\n// reads a markdown file and writes an HTML file\nlitdoc({\n  markdownPath: path.join(__dirname, '../README.md'),\n  outputPath: path.join(__dirname, '../index.html')\n});\n```\n\n\n### Global Installation \u0026 Usage\n\nIf you'd prefer to make `litdoc` available across all your projects, you can install it locally with `npm`.\n\n```bash\n$ npm install -g litdoc\n```\n\nYou can use it as a CLI tool from anyplace on your machine.\n\n```bash\n$ litdoc input.md output.html\n```\n\n\n## Reference\n\nBelow is the reference for the only function `litdoc` exposes.\n\n### litdoc()\n\n* `title` - default `'Documentation'`\n* `markdown` - default `undefined` - overrides `markdownPath`\n* `markdownPath` - default `undefined`\n* `css` - default `undefined` - overrides `cssPath`\n* `cssPath` - default `'assets/base.css'` - litdoc provided\n* `template` - default `undefined` - overrides `templatePath`\n * this is neat\n* `templatePath` - default `'templates/index.jst'` - litdoc provided\n* `outputPath` - default `undefined`\n\n\u003e You _must_ provide either `markdown` or `markdownPath`.\n\n```js\nvar litdoc = require('litdoc');\n\nlitdoc({\n  title: 'Documentation',\n  markdown: undefined,\n  markdownPath: undefined,\n  css: undefined,\n  cssPath: 'assets/base.css', // litdoc provided\n  template: undefined,\n  templatePath: 'templates/index.jst', // litdoc provided\n  outputPath: undefined,\n});\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzapier%2Flitdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzapier%2Flitdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzapier%2Flitdoc/lists"}