teedoc


Nameteedoc JSON
Version 1.37.1 PyPI version JSON
download
home_pagehttps://github.com/Neutree/teedoc
Summarydoc site generator with multiple doc support
upload_time2024-03-04 07:16:49
maintainer
docs_urlNone
authorNeucrack
requires_python
licenseMIT
keywords doc website markdown jupyter notbook generator teedoc
VCS
bugtrack_url
requirements coloredlogs mistune watchdog nbconvert PyYAML jinja2 flask babel requests progress html2text
Travis-CI No Travis.
coveralls test coverage No coveralls.
            teedoc
===========

[中文](./README_ZH.md) | English

[![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)

<img src="https://teedoc.github.io/static/image/logo.png" height=64/> 

Official site: [teedoc.neucrack.com](https://teedoc.neucrack.com) or [teedoc.github.io](https://teedoc.github.io/)

More 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)

documentation generate tool from markdown and jupyter notebook to html

![](./assets/images/teedoc_screenshot_0.png)

`teedoc` can be used in the following scenarios:
* Build a document website, and it is best to support multiple documents and custom pages
* Organizations' or companies' docs spread in different domains, wish to combine them to one site(domain)
* Build a `WiKi` website
* Build personal or corporate knowledge base
* Build personal or corporate website


## Features

- [x] Easy to use, cross platform, only need `Python3`
- [x] Easy to deploy, only copy generated staitc HTML files to your server or other host
- [x] Easy to write, markdown support
- [x] Jupyter notebook support
- [x] Multiple docs support
- [x] Plugin support
- [x] Multiple theme support(support by plugin)
- [x] Control the style accurate to the page through css (implemented by customizing the id and class of each page)
- [x] Multi-level directory support
- [x] Multi-language support (manual translation) (Internationalization/i18n)
- [x] Multilingual support (translation plugin)
- [x] Multiple version support
- [x] Search support
- [x] SEO friendly
- [x] Real-time preview file changes
- [x] Parallel build, faster build speed
- [x] Blog support
- [x] Jinja2 HTML layout template support


## Get Started

Visit official site: [teedoc.github.io](https://teedoc.github.io/) or [teedoc.neucrack.com](https://teedoc.neucrack.com/)

## Create your website on github pages in minutes

See [template repo](https://github.com/teedoc/template)

## Quik start

* Install python3

On `Windows` or `macOS`, download from [python.org](https://www.python.org/downloads/)

On `Linux`, `Ubuntu` for example:

```
sudo apt install python3 python3-pip
```

* Install teedoc

This command will **install teedoc program**

```
pip3 install -U teedoc
```

* Initialize document

```
mkdir my_site
cd my_site
teedoc init
```

or

```
teedoc -d my_site init
```

> select minimal template in promot

* Install plugins

This command will **install plugins** used by doc(set in `site_config.json`)

```
cd my_site
teedoc install
```

* build or serve

```
teedoc serve
```

then visit [http://127.0.0.1:2333](http://127.0.0.1:2333) in browser

If you only want to generate htmls:

```
teedoc build
```




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Neutree/teedoc",
    "name": "teedoc",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "doc website markdown jupyter notbook generator teedoc",
    "author": "Neucrack",
    "author_email": "CZD666666@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/54/41/d2c78da1441091505143d1737427726ccc469b53d1301bba5e073aae70b2/teedoc-1.37.1.tar.gz",
    "platform": null,
    "description": "teedoc\n===========\n\n[\u4e2d\u6587](./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<img src=\"https://teedoc.github.io/static/image/logo.png\" height=64/> \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> 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\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "doc site generator with multiple doc support",
    "version": "1.37.1",
    "project_urls": {
        "Homepage": "https://github.com/Neutree/teedoc"
    },
    "split_keywords": [
        "doc",
        "website",
        "markdown",
        "jupyter",
        "notbook",
        "generator",
        "teedoc"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4bbbc85e479c1e9ba08e9f99a23f5fa0a3f16539b21a922e40450ca562e8cfa9",
                "md5": "a761a45bd4e703c3d5d5ac665616cef4",
                "sha256": "e77924c1e1d959a65ba6f74b611feff36c9d8acc963c4d6daf35b51347cdfba2"
            },
            "downloads": -1,
            "filename": "teedoc-1.37.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a761a45bd4e703c3d5d5ac665616cef4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 855909,
            "upload_time": "2024-03-04T07:16:45",
            "upload_time_iso_8601": "2024-03-04T07:16:45.274551Z",
            "url": "https://files.pythonhosted.org/packages/4b/bb/c85e479c1e9ba08e9f99a23f5fa0a3f16539b21a922e40450ca562e8cfa9/teedoc-1.37.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5441d2c78da1441091505143d1737427726ccc469b53d1301bba5e073aae70b2",
                "md5": "276109fc445e22b298614ceb27cdf250",
                "sha256": "69e90875bbffc58b11c849b0d7d73593bc5247e962c81d42f13a630a9c9a648e"
            },
            "downloads": -1,
            "filename": "teedoc-1.37.1.tar.gz",
            "has_sig": false,
            "md5_digest": "276109fc445e22b298614ceb27cdf250",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 845710,
            "upload_time": "2024-03-04T07:16:49",
            "upload_time_iso_8601": "2024-03-04T07:16:49.289046Z",
            "url": "https://files.pythonhosted.org/packages/54/41/d2c78da1441091505143d1737427726ccc469b53d1301bba5e073aae70b2/teedoc-1.37.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-04 07:16:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Neutree",
    "github_project": "teedoc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "coloredlogs",
            "specs": [
                [
                    ">=",
                    "15.0.1"
                ]
            ]
        },
        {
            "name": "mistune",
            "specs": [
                [
                    "<",
                    "3"
                ],
                [
                    ">=",
                    "2.0.3"
                ]
            ]
        },
        {
            "name": "watchdog",
            "specs": [
                [
                    ">=",
                    "2.1.7"
                ]
            ]
        },
        {
            "name": "nbconvert",
            "specs": [
                [
                    ">=",
                    "7.0.0"
                ]
            ]
        },
        {
            "name": "PyYAML",
            "specs": [
                [
                    ">=",
                    "5.4.1"
                ]
            ]
        },
        {
            "name": "jinja2",
            "specs": [
                [
                    ">=",
                    "3.1.1"
                ]
            ]
        },
        {
            "name": "flask",
            "specs": [
                [
                    ">=",
                    "2.0.2"
                ]
            ]
        },
        {
            "name": "babel",
            "specs": [
                [
                    ">=",
                    "2.9.1"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "progress",
            "specs": []
        },
        {
            "name": "html2text",
            "specs": []
        }
    ],
    "lcname": "teedoc"
}
        
Elapsed time: 0.20999s