{"id":14972242,"url":"https://github.com/mushiyo/pandoc-toc-sidebar","last_synced_at":"2025-10-24T21:33:23.035Z","repository":{"id":39105568,"uuid":"63942323","full_name":"Mushiyo/pandoc-toc-sidebar","owner":"Mushiyo","description":"A Pandoc HTML template with TOC on the sidebar, using Bootstrap 3","archived":false,"fork":false,"pushed_at":"2022-05-31T19:41:54.000Z","size":299,"stargazers_count":71,"open_issues_count":5,"forks_count":22,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-31T22:22:30.179Z","etag":null,"topics":["bootstrap3","navbar","pandoc-template","sidebar"],"latest_commit_sha":null,"homepage":"","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/Mushiyo.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}},"created_at":"2016-07-22T09:40:08.000Z","updated_at":"2024-12-27T07:20:02.000Z","dependencies_parsed_at":"2022-08-18T19:34:05.173Z","dependency_job_id":null,"html_url":"https://github.com/Mushiyo/pandoc-toc-sidebar","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mushiyo%2Fpandoc-toc-sidebar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mushiyo%2Fpandoc-toc-sidebar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mushiyo%2Fpandoc-toc-sidebar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mushiyo%2Fpandoc-toc-sidebar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mushiyo","download_url":"https://codeload.github.com/Mushiyo/pandoc-toc-sidebar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238386106,"owners_count":19463300,"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":["bootstrap3","navbar","pandoc-template","sidebar"],"created_at":"2024-09-24T13:46:37.027Z","updated_at":"2025-10-24T21:33:22.948Z","avatar_url":"https://github.com/Mushiyo.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pandoc-toc-sidebar\nA [Pandoc](http://pandoc.org/) HTML template modified from Bootstrap [dashboard example](http://getbootstrap.com/examples/dashboard/).  \nIt has a navbar on the top of the page for website navigation, and a TOC (table of contents) on the sidebar for page navigaion, suitable for building website with Pandoc.\n\n## Usage\n1. Download the ZIP file then unzip it, or  \n  ```sh\n  git clone https://github.com/Mushiyo/pandoc-toc-sidebar.git\n  ```\n  \n2. Put the file(s) which you want to convert into HTML with Pandoc into the `pandoc-toc-sidebar` folder.\n  Then\n  ```sh\n  cd pandoc-toc-sidebar\n  ```\n\n3. Modify the `nav` file to fit your website structure.  \n   The code in the `nav` file is a Bootstrap navbar.\n  \n4. Assume the file to convert is `input.md`, then the command will look like\n  ```sh\n  pandoc input.md --template toc-sidebar.html -B nav -o outWithoutTOC.html\n  ```\n  If you want to add TOC, then the command will look like\n  ```sh\n  pandoc input.md --template toc-sidebar.html --toc -B nav -o outWithTOC.html\n  ```\n  \n### Options\n#### Local or self-contained css and JavaScript files\nFor local css and JavaScript files, or using Pandoc's `--self-contained` option, replace `toc-sidebar.html` with `toc-sidebarL.html` in step 4.  \n\n#### `\u003ctable\u003e` styles\nThe `\u003ctable\u003e` styles here are the following Bootstrap table classes: `.table`, `table-bordered` and `table-hover`.\nYou can change the styles by modifying line 104 in [toc-sidebar.html](toc-sidebar.html#L104) (or [toc-sidebarL.html](toc-sidebarL.html#L104) if local css and js files are used).\nFor example, if you want `.table-striped`, just replace `table table-bordered table-hover` into `table table-striped`.\nRead [Bootstrap documentation](http://getbootstrap.com/css/#tables) for more Bootstrap table styles.\n\n#### No navbar\nIf you do not want a navbar, you can remove `-B nav` option in step 4. However, for the time being, this will result in a not good looking layout :(   \n\n## Output examples\n### A single page\nThe following output examples are converted from [Pandoc's README file](https://github.com/jgm/pandoc/blob/master/README) and is using `toc-sidebarL.html` template\n* with TOC: \u003chttps://mushiyo.github.io/pandoc-toc-sidebar/outWithTOC.html\u003e\n* without TOC: \u003chttps://mushiyo.github.io/pandoc-toc-sidebar/outWithoutTOC.html\u003e\n\n### A website\n[My notes](http://twilightzone.gitlab.io/note), the contents are mostly written in Chinese, you can find the markdown source files [here](https://github.com/Mushiyo/note).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmushiyo%2Fpandoc-toc-sidebar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmushiyo%2Fpandoc-toc-sidebar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmushiyo%2Fpandoc-toc-sidebar/lists"}