{"id":16285566,"url":"https://github.com/tonyfast/nbd","last_synced_at":"2026-04-28T18:33:12.352Z","repository":{"id":75804574,"uuid":"99398090","full_name":"tonyfast/nbd","owner":"tonyfast","description":"bootstrapped notebook documentation","archived":false,"fork":false,"pushed_at":"2017-09-12T15:57:36.000Z","size":1171,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-09T03:22:26.019Z","etag":null,"topics":["bootstrap","documentation","jupyter-notebook","notebook"],"latest_commit_sha":null,"homepage":"https://tonyfast.github.io/nbd","language":"Jupyter Notebook","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/tonyfast.png","metadata":{"files":{"readme":"readme.ipynb","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":"2017-08-05T04:06:19.000Z","updated_at":"2017-09-10T12:43:12.000Z","dependencies_parsed_at":"2023-03-14T15:45:30.599Z","dependency_job_id":null,"html_url":"https://github.com/tonyfast/nbd","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/tonyfast/nbd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyfast%2Fnbd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyfast%2Fnbd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyfast%2Fnbd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyfast%2Fnbd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tonyfast","download_url":"https://codeload.github.com/tonyfast/nbd/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonyfast%2Fnbd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32394432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T14:34:11.604Z","status":"ssl_error","status_checked_at":"2026-04-28T14:32:37.009Z","response_time":56,"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":["bootstrap","documentation","jupyter-notebook","notebook"],"created_at":"2024-10-10T19:25:14.888Z","updated_at":"2026-04-28T18:33:12.317Z","avatar_url":"https://github.com/tonyfast.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"{\n \"cells\": [\n  {\n   \"cell_type\": \"markdown\",\n   \"metadata\": {},\n   \"source\": [\n    \"# It's `no big deal`, it just works.\\n\",\n    \"\\n\",\n    \"Documentation ∀ files; based on the [`nbformat`](nbformat.readthedocs.io).\\n\",\n    \"\\n\",\n    \"#### Install with version control\\n\",\n    \"\\n\",\n    \"`pip install git+`\u003ccode\u003e\u003ca href=\\\"https://github.com/tonyfast/nbd/\\\"\u003ehttps://github.com/tonyfast/nbd/\u003c/a\u003e\u003c/code\u003e\\n\"\n   ]\n  },\n  {\n   \"cell_type\": \"markdown\",\n   \"metadata\": {},\n   \"source\": [\n    \"## Why\\n\",\n    \"\\n\",\n    \"* `nbconvert` doesn't accept all file formats.  `nbd` adds the concept of loaders\\n\",\n    \"that transform arbitrary files to the nbformat.\"\n   ]\n  },\n  {\n   \"cell_type\": \"markdown\",\n   \"metadata\": {},\n   \"source\": [\n    \"## An Example Configuration\"\n   ]\n  },\n  {\n   \"cell_type\": \"markdown\",\n   \"metadata\": {},\n   \"source\": [\n    \"### 1. Configure your documentation in python\"\n   ]\n  },\n  {\n   \"cell_type\": \"markdown\",\n   \"metadata\": {},\n   \"source\": [\n    \"More configuration options are available at [nbconvert.readthedocs.io/en/latest/config_options.html]()\"\n   ]\n  },\n  {\n   \"cell_type\": \"code\",\n   \"execution_count\": 1,\n   \"metadata\": {},\n   \"outputs\": [\n    {\n     \"name\": \"stdout\",\n     \"output_type\": \"stream\",\n     \"text\": [\n      \"Overwriting demo.py\\n\"\n     ]\n    }\n   ],\n   \"source\": [\n    \"%%file demo.py\\n\",\n    \"from nbd import *\\n\",\n    \"# use nbd's super basic index\\n\",\n    \"\\n\",\n    \"from nbd import index\\n\",\n    \"\\n\",\n    \"# Store data in a notebook object\\n\",\n    \"data = notebook(cells=[\\n\",\n    \"    markdown('''# My Demo Page \\\\n\\\\nCheck out the complete [`nbd` documentation](../index.html).''')])\\n\",\n    \"\\n\",\n    \"def report(): yield 'index', data\\n\",\n    \"    \\n\",\n    \"c.Docs.notebooks = ['nbd.ipynb', 'readme.md', 'nbd.py']\\n\",\n    \"c.FilesWriter.build_directory = 'docs/demo'\\n\",\n    \"c.Docs.post, c.Docs.report = __import__('nbd').index(data), report\"\n   ]\n  },\n  {\n   \"cell_type\": \"markdown\",\n   \"metadata\": {},\n   \"source\": [\n    \"### 2. Execute `nbd`\"\n   ]\n  },\n  {\n   \"cell_type\": \"code\",\n   \"execution_count\": 2,\n   \"metadata\": {},\n   \"outputs\": [\n    {\n     \"name\": \"stdout\",\n     \"output_type\": \"stream\",\n     \"text\": [\n      \"[Docs] Converting notebook nbd.ipynb to html\\r\\n\",\n      \"[Docs] Writing 280231 bytes to docs/demo/nbd.ipynb.html\\r\\n\",\n      \"[Docs] Converting notebook readme.md to html\\r\\n\",\n      \"[Docs] Writing 257617 bytes to docs/demo/readme.md.html\\r\\n\",\n      \"[Docs] Converting notebook nbd.py to html\\r\\n\",\n      \"[Docs] Writing 275472 bytes to docs/demo/nbd.py.html\\r\\n\",\n      \"[Docs] Converting notebook into html\\r\\n\",\n      \"[Docs] Writing 250170 bytes to docs/demo/index.html\\r\\n\"\n     ]\n    }\n   ],\n   \"source\": [\n    \"!jupyter nbd --config demo.py\"\n   ]\n  },\n  {\n   \"cell_type\": \"markdown\",\n   \"metadata\": {},\n   \"source\": [\n    \"## Motivation\\n\",\n    \"\\n\",\n    \"* An Ipython backed make configuration system\\n\",\n    \"* It works for every file\"\n   ]\n  },\n  {\n   \"cell_type\": \"markdown\",\n   \"metadata\": {},\n   \"source\": [\n    \"## Developer\\n\",\n    \"\\n\",\n    \"Configure the documentation for this project through the readme file.\"\n   ]\n  },\n  {\n   \"cell_type\": \"code\",\n   \"execution_count\": 3,\n   \"metadata\": {},\n   \"outputs\": [\n    {\n     \"name\": \"stdout\",\n     \"output_type\": \"stream\",\n     \"text\": [\n      \"[NbConvertApp] Converting notebook config.ipynb to python\\r\\n\",\n      \"[NbConvertApp] Writing 1182 bytes to ./config.py\\r\\n\",\n      \"[NbConvertApp] Converting notebook nbd.ipynb to python\\r\\n\",\n      \"[NbConvertApp] Writing 5966 bytes to ./nbd.py\\r\\n\",\n      \"parsing nbd.py...\\r\\n\",\n      \"[NbConvertApp] Converting notebook readme.ipynb to markdown\\r\\n\",\n      \"[NbConvertApp] Writing 2721 bytes to readme.md\\r\\n\",\n      \"[Docs] Converting notebook nbd.ipynb to html\\r\\n\",\n      \"[Docs] Writing 280231 bytes to docs/nbd.ipynb.html\\r\\n\",\n      \"[Docs] Converting notebook config.ipynb to html\\r\\n\",\n      \"[Docs] Writing 256375 bytes to docs/config.ipynb.html\\r\\n\",\n      \"[Docs] Converting notebook config.py to html\\r\\n\",\n      \"[Docs] Writing 254329 bytes to docs/config.py.html\\r\\n\",\n      \"[Docs] Converting notebook template.ipynb to html\\r\\n\",\n      \"[Docs] Writing 250263 bytes to docs/template.ipynb.html\\r\\n\",\n      \"[Docs] Converting notebook readme.md to html\\r\\n\",\n      \"[Docs] Writing 257146 bytes to docs/readme.md.html\\r\\n\",\n      \"[Docs] Converting notebook flake8.txt to html\\r\\n\",\n      \"[Docs] Writing 271255 bytes to docs/flake8.txt.html\\r\\n\",\n      \"[Docs] Converting notebook into html\\r\\n\",\n      \"[Docs] Writing 252550 bytes to docs/index.html\\r\\n\",\n      \"[Docs] Converting notebook into html\\r\\n\",\n      \"[Docs] Writing 249380 bytes to docs/uml.html\\r\\n\"\n     ]\n    }\n   ],\n   \"source\": [\n    \"!jupyter nbconvert --to python config.ipynb nbd.ipynb --output-dir .\\n\",\n    \"!flake8 nbd.py --output-file=flake8.txt\\n\",\n    \"!pyreverse -o png -p nbd nbd.py\\n\",\n    \"!jupyter nbconvert --to markdown readme.ipynb\\n\",\n    \"!jupyter nbd --config config.py\\n\",\n    \"!mv classes_nbd.png config.py flake8.txt docs\\n\",\n    \"# !wget https://bootswatch.com/readable/bootstrap.min.css --no-check-certificate\\n\",\n    \"# !mv bootstrap.min.css docs/custom.css\"\n   ]\n  },\n  {\n   \"cell_type\": \"markdown\",\n   \"metadata\": {},\n   \"source\": [\n    \"## Views\\n\",\n    \"### HTML Views\\n\",\n    \"\\n\",\n    \"* [Raw Git](https://rawgit.com/tonyfast/nbd/master/docs/index.html)\\n\",\n    \"* [Github Pages](https://tonyfast.github.io/nbd)\\n\",\n    \"\\n\",\n    \"### Notebook Views\\n\",\n    \"\\n\",\n    \"* [nbviewer](http://nbviewer.jupyter.org/github/tonyfast/nbd/blob/master/readme.ipynb)\\n\",\n    \"* [github](https://github.com/tonyfast/nbd/blob/master/usage/readme.ipynb)\"\n   ]\n  },\n  {\n   \"cell_type\": \"code\",\n   \"execution_count\": null,\n   \"metadata\": {},\n   \"outputs\": [],\n   \"source\": []\n  }\n ],\n \"metadata\": {\n  \"kernelspec\": {\n   \"display_name\": \"Python 3\",\n   \"language\": \"python\",\n   \"name\": \"python3\"\n  },\n  \"language_info\": {\n   \"codemirror_mode\": {\n    \"name\": \"ipython\",\n    \"version\": 3\n   },\n   \"file_extension\": \".py\",\n   \"mimetype\": \"text/x-python\",\n   \"name\": \"python\",\n   \"nbconvert_exporter\": \"python\",\n   \"pygments_lexer\": \"ipython3\",\n   \"version\": \"3.5.3\"\n  }\n },\n \"nbformat\": 4,\n \"nbformat_minor\": 2\n}\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonyfast%2Fnbd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftonyfast%2Fnbd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonyfast%2Fnbd/lists"}