{"id":26610493,"url":"https://github.com/iwillspeak/docket","last_synced_at":"2025-04-10T00:05:02.178Z","repository":{"id":39707584,"uuid":"109572024","full_name":"iwillspeak/docket","owner":"iwillspeak","description":"Simple Markdown to HTML documentation rendering","archived":false,"fork":false,"pushed_at":"2023-06-25T14:26:09.000Z","size":518,"stargazers_count":23,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T00:04:38.119Z","etag":null,"topics":["markdown","rust","static-site-generator"],"latest_commit_sha":null,"homepage":"http://willspeak.me/docket/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iwillspeak.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"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-05T11:06:32.000Z","updated_at":"2024-09-13T02:28:35.000Z","dependencies_parsed_at":"2022-07-18T03:30:42.696Z","dependency_job_id":null,"html_url":"https://github.com/iwillspeak/docket","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iwillspeak%2Fdocket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iwillspeak%2Fdocket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iwillspeak%2Fdocket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iwillspeak%2Fdocket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iwillspeak","download_url":"https://codeload.github.com/iwillspeak/docket/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248131320,"owners_count":21052819,"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":["markdown","rust","static-site-generator"],"created_at":"2025-03-24T01:48:28.792Z","updated_at":"2025-04-10T00:05:02.140Z","avatar_url":"https://github.com/iwillspeak.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docket\n\n[![Build Status][build_badge_image]][build_info] [![Build Docker Container][docker_badge_image]][docker_info]\n\nSimple markdown to HTML documentation rendering. Docket aims to be a Rust clone of [`d`](https://github.com/sjl/d).\n\n## Key Features\n\n* Binary which can be installed with `cargo install`\n* Command line argument parsing with [Docopt](https://docs.rs/docopt/0.8.1/docopt/)\n* Markdown rendering with `pulldown-cmark`.\n* Syntax highlighting with [Syntect](https://github.com/trishume/syntect/).\n* Javascript powered search.\n* Zero-configuration.\n\n## Installation\n\nDocket can be installed with cargo via `cargo install docket`. Once installed you should be able to run it form the command line as `docket`.\n\nDocket has two Cargo features which are enabled by default. You can disable them with `--no-default-features` when installing if you don't need them to save some time.\n\n * `watch` - Support for watching files and re-generating the output folder when changes are made.\n * `par_render` - Support for rendering pages in parallel using the Rayon crate.\n\n## Getting Started\n\nTo begin creating your documentation create a new `docs/` folder at the root of your repository. Add a file called `index.md` with a short markdown description of the project. Add pages by creating new markdown files in the `docs/` folder. Each page should have a level-1 heading at the beginning which is treated as the title of the page. \n\nTo render the HTML output change to the `docs/` folder and run `docket`. This should create a new `docs/build/` folder containing the rendered site; ready to be published to a web-server or served with GitHub Pages. For more information about setup and configuration [check out the docs](https://iwillspeak.github.io/docket/).\n\n [build_badge_image]: https://dev.azure.com/iwillspeak/GitHub/_apis/build/status/iwillspeak.docket?branchName=main\n [build_info]: https://dev.azure.com/iwillspeak/GitHub/_build/latest?definitionId=1\u0026branchName=main\n [docker_badge_image]: https://github.com/iwillspeak/docket/actions/workflows/container.yml/badge.svg\n [docker_info]: https://github.com/iwillspeak/docket/actions/workflows/container.yml","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiwillspeak%2Fdocket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiwillspeak%2Fdocket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiwillspeak%2Fdocket/lists"}