{"id":14977395,"url":"https://github.com/teedoc/teedoc","last_synced_at":"2025-05-15T23:04:05.469Z","repository":{"id":37628840,"uuid":"330161685","full_name":"teedoc/teedoc","owner":"teedoc","description":"wiki and multi docs friendly static document site generator(doc generator), convert markdown and jupyter notebook to html website. wiki 和多文档友好的静态文档网站生成工具","archived":false,"fork":false,"pushed_at":"2025-04-22T04:03:46.000Z","size":2880,"stargazers_count":245,"open_issues_count":15,"forks_count":24,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-04T09:40:13.845Z","etag":null,"topics":["doc","docs","generator","generators","html","jupyter","markdown","multi","python","site","teedoc","website","wiki"],"latest_commit_sha":null,"homepage":"https://teedoc.neucrack.com","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teedoc.png","metadata":{"files":{"readme":"README.md","changelog":"history.md","contributing":null,"funding":null,"license":"LICENSE","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":"2021-01-16T12:50:16.000Z","updated_at":"2025-04-22T04:03:51.000Z","dependencies_parsed_at":"2024-06-01T18:12:54.073Z","dependency_job_id":"45981ed0-a148-4613-8064-1f4f3e947113","html_url":"https://github.com/teedoc/teedoc","commit_stats":{"total_commits":492,"total_committers":4,"mean_commits":123.0,"dds":"0.014227642276422814","last_synced_commit":"4c6c7a525144dc3e9fd4034840e52e48dbdeb967"},"previous_names":["neutree/teedoc"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teedoc%2Fteedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teedoc%2Fteedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teedoc%2Fteedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teedoc%2Fteedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teedoc","download_url":"https://codeload.github.com/teedoc/teedoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254436944,"owners_count":22070946,"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":["doc","docs","generator","generators","html","jupyter","markdown","multi","python","site","teedoc","website","wiki"],"created_at":"2024-09-24T13:55:35.154Z","updated_at":"2025-05-15T23:04:05.430Z","avatar_url":"https://github.com/teedoc.png","language":"CSS","readme":"teedoc\n===========\n\n[中文](./README_ZH.md) | English\n\n[![License](https://img.shields.io/github/license/teedoc/teedoc?color=red)](./LICENSE) [![PyPI](https://img.shields.io/pypi/v/teedoc)](https://pypi.org/project/teedoc/#history) ![PyPI - Downloads](https://img.shields.io/pypi/dm/teedoc?color=brightgreen) ![PyPI - Downloads](https://img.shields.io/pypi/dw/teedoc?color=brightgreen) [![build](https://github.com/teedoc/teedoc/actions/workflows/test.yml/badge.svg)](https://github.com/teedoc/teedoc/actions/workflows/test.yml) [![GitHub Repo stars](https://img.shields.io/github/stars/teedoc/teedoc?style=social)](https://github.com/teedoc/teedoc)\n\n\u003cimg src=\"https://teedoc.github.io/static/image/logo.png\" height=64/\u003e \n\nOfficial site: [teedoc.neucrack.com](https://teedoc.neucrack.com) or [teedoc.github.io](https://teedoc.github.io/)\n\nMore demo: see [here](https://teedoc.neucrack.com/get_started/zh/usage/sites.html) or [here](https://teedoc.github.io/get_started/zh/usage/sites.html)\n\ndocumentation generate tool from markdown and jupyter notebook to html\n\n![](./assets/images/teedoc_screenshot_0.png)\n\n`teedoc` can be used in the following scenarios:\n* Build a document website, and it is best to support multiple documents and custom pages\n* Organizations' or companies' docs spread in different domains, wish to combine them to one site(domain)\n* Build a `WiKi` website\n* Build personal or corporate knowledge base\n* Build personal or corporate website\n\n\n## Features\n\n- [x] Easy to use, cross platform, only need `Python3`\n- [x] Easy to deploy, only copy generated staitc HTML files to your server or other host\n- [x] Easy to write, markdown support\n- [x] Jupyter notebook support\n- [x] Multiple docs support\n- [x] Plugin support\n- [x] Multiple theme support(support by plugin)\n- [x] Control the style accurate to the page through css (implemented by customizing the id and class of each page)\n- [x] Multi-level directory support\n- [x] Multi-language support (manual translation) (Internationalization/i18n)\n- [x] Multilingual support (translation plugin)\n- [x] Multiple version support\n- [x] Search support\n- [x] SEO friendly\n- [x] Real-time preview file changes\n- [x] Parallel build, faster build speed\n- [x] Blog support\n- [x] Jinja2 HTML layout template support\n\n\n## Get Started\n\nVisit official site: [teedoc.github.io](https://teedoc.github.io/) or [teedoc.neucrack.com](https://teedoc.neucrack.com/)\n\n## Create your website on github pages in minutes\n\nSee [template repo](https://github.com/teedoc/template)\n\n## Quik start\n\n* Install python3\n\nOn `Windows` or `macOS`, download from [python.org](https://www.python.org/downloads/)\n\nOn `Linux`, `Ubuntu` for example:\n\n```\nsudo apt install python3 python3-pip\n```\n\n* Install teedoc\n\nThis command will **install teedoc program**\n\n```\npip3 install -U teedoc\n```\n\n* Initialize document\n\n```\nmkdir my_site\ncd my_site\nteedoc init\n```\n\nor\n\n```\nteedoc -d my_site init\n```\n\n\u003e select minimal template in promot\n\n* Install plugins\n\nThis command will **install plugins** used by doc(set in `site_config.json`)\n\n```\ncd my_site\nteedoc install\n```\n\n* build or serve\n\n```\nteedoc serve\n```\n\nthen visit [http://127.0.0.1:2333](http://127.0.0.1:2333) in browser\n\nIf you only want to generate htmls:\n\n```\nteedoc build\n```\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteedoc%2Fteedoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteedoc%2Fteedoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteedoc%2Fteedoc/lists"}