{"id":15169481,"url":"https://github.com/phly/bookdown2mkdocs","last_synced_at":"2026-01-20T09:34:56.910Z","repository":{"id":36804826,"uuid":"41111662","full_name":"phly/bookdown2mkdocs","owner":"phly","description":"Convert bookdown.json to mkdocs.yml for syndication on rtfd.org","archived":false,"fork":false,"pushed_at":"2015-08-24T20:43:17.000Z","size":124,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-14T06:35:57.717Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-20T18:15:08.000Z","updated_at":"2015-08-20T18:15:39.000Z","dependencies_parsed_at":"2022-09-04T03:23:13.847Z","dependency_job_id":null,"html_url":"https://github.com/phly/bookdown2mkdocs","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/phly/bookdown2mkdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phly%2Fbookdown2mkdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phly%2Fbookdown2mkdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phly%2Fbookdown2mkdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phly%2Fbookdown2mkdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phly","download_url":"https://codeload.github.com/phly/bookdown2mkdocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phly%2Fbookdown2mkdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28600715,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T08:51:33.170Z","status":"ssl_error","status_checked_at":"2026-01-20T08:51:10.855Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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-09-27T07:01:53.517Z","updated_at":"2026-01-20T09:34:56.904Z","avatar_url":"https://github.com/phly.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bookdown2Mkdocs\n\n\u003e :warning: **Archived 2025-08-17**\n\u003e \n\u003e Use at your own risk.\n\nConvert your `bookdown.json` files to `mkdocs.yml` so that you can publish\ndocumentation to rtfd.org:\n\n```bash\n$ cd project-with-bookdown\n$ path/to/bin/bookdown2mkdocs.php convert doc/bookdown.json \\\n\u003e --site-name=my-project \\\n\u003e --repo-url=http://example.com/project \\\n\u003e --copyright-author=\"Me Me Me\" \\\n\u003e --copyright-url=http://example.com\n```\n\n\u003e ## Caveats\n\u003e\n\u003e - The command assumes that your documentation is in `doc/book/`.\n\u003e - The command assumes that you want rendered documentation in `doc/html/`.\n\u003e - The command will create a symlink `doc/book/index.md` pointing to the\n\u003e   project `README.md` if such a symlink does not exist. This is because you\n\u003e   cannot have `index` pages in bookdown; those are reserved for auto-generated\n\u003e   TOCs.\n\u003e - References to remote `bookdown.json` files will not work, only local files.\n\u003e - The command *will* overwrite `mkdocs.yml`.\n\n## Installation\n\nUse [Composer](https://getcomposer.org) to install the tool:\n\n```bash\n$ composer global require phly/bookdown2mkdocs\n```\n\nTip: add `$HOME/.composer/vendor/bin` to your `$PATH`.\n\n## Usage\n\nExcecute the command in the root of your project.\n\n\u003e bookdown2mkdocs.php convert [\u003cbookdown-path\u003e] --site-name= --repo-url= --copyright-url= --copyright-author= [--mkdocs=]\n\n### Arguments\n\n- `[\u003cbookdown-path\u003e]`: Path to bookdown.json; if not present, assumes doc/bookdown.json\n- `--site-name=`: Site/project name; typically used as the subdomain in rtfd.org\n- `--repo-url=`: Repository URI (linked from generated docs)\n- `--copyright-url=`: URL associated with the copyright holder\n- `--copyright-author=`: Copyright holder/author\n- `[--mkdocs=]`: Additional default configuration for mkdocs, as a JSON string\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphly%2Fbookdown2mkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphly%2Fbookdown2mkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphly%2Fbookdown2mkdocs/lists"}