{"id":22768397,"url":"https://github.com/terraphim/md-book","last_synced_at":"2026-01-31T06:33:11.025Z","repository":{"id":265561146,"uuid":"896260064","full_name":"terraphim/md-book","owner":"terraphim","description":"Rust documentation can be pretty","archived":false,"fork":false,"pushed_at":"2024-12-09T20:17:49.000Z","size":10164,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T11:15:50.851Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","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/terraphim.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":"2024-11-29T22:40:21.000Z","updated_at":"2024-12-09T13:52:54.000Z","dependencies_parsed_at":"2025-02-05T12:49:26.916Z","dependency_job_id":"3bcf3c0d-7755-4520-b15c-30ca7b0c726f","html_url":"https://github.com/terraphim/md-book","commit_stats":null,"previous_names":["terraphim/md-book"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraphim%2Fmd-book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraphim%2Fmd-book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraphim%2Fmd-book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraphim%2Fmd-book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terraphim","download_url":"https://codeload.github.com/terraphim/md-book/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251344234,"owners_count":21574515,"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-12-11T14:11:25.308Z","updated_at":"2026-01-31T06:33:05.988Z","avatar_url":"https://github.com/terraphim.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MD book is a mdbook replacement with some extra features\n## Run\nCheckout the source code and run:\n\n```rust\ncargo run -- -i ../mdBook/test_book  -o ./test_mdbook\n```\n\n-i is the input directory and -o is the output directory.\ninput directory is the directory with md files.\n\nThe tool will generate the input directory with markdown files and the output directory with HTML files ready to be deployed on any static site. \n\nAdjust the styling in the src/templates/css/styles.css file.\n\nOr anything you want to change in the src/templates folder. It's a standard Tera template, so you can add your own custom stuff there.\n\n## Styling\n\n* Nicer default styling for content - multiple columns for horizontal layout,\n* Right-hand TOC to navigate around the page.\n* Create index.md to create content for the home page; alternatively, it will create a list of cards with all the pages as an index.\n\n\n- Code blocks with syntax highlighting\n\n- Better default styling\n\n# Screenshots\n\n![screen_resize](gif/screen_resize.gif)\n![screen](gif/screen.gif)\n\n# Configuration\n\nYou can add a book.toml file to the input directory to configure the book.\n\nSupports TOML configuration via book.toml\nAllows overriding with environment variables (prefixed with MDBOOK_)\nSupports command-line arguments\nEnables shell expansion in config file paths\nProvides default values for optional fields\nExample usage:\n\n```bash\n# Using environment variables\nMDBOOK_BOOK.TITLE=\"My Book\" ./md-book -i input -o output\n\n# Using custom config file\n./md-book -i input -o output -c ~/my-config.toml\n\n# Config values can be nested using an underscore\nMDBOOK_OUTPUT.HTML.MATHJAX_SUPPORT=true ./md-book -i input -o output\n```\nThe configuration system follows the priority order:\n1. Command line arguments (highest priority)\n2. Environment variables (prefixed with MDBOOK_)\n3. Custom config file (if provided)\n4. Default book.toml\n5. Default values (lowest priority)\nyou shall be able to feed config into json and yaml files.\n\n# Serve and Watch\n\n## Just build\n```bash\ncargo run -- -i input -o output\n```\n\n## Build and watch\n```bash\ncargo run -- -i input -o output --watch\n```\n\n## Build and serve\n```bash\ncargo run -- -i input -o output --serve\n```\n\n## Build, watch and serve on custom port\n```bash\ncargo run -- -i input -o output --watch --serve --port 8080\n```\n\n# TODO\n- [ ] Rust specific synax highlight (Good first issue)\n- [ ] Search (WIP)\n- [ ] Mathjax \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterraphim%2Fmd-book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterraphim%2Fmd-book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterraphim%2Fmd-book/lists"}