add site content

teedoc · Jan 28, 2021 · a0f363e · a0f363e
1 parent 04f7bcb
commit a0f363e
Show file tree

Hide file tree

Showing 37 changed files with 1,059 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+out
+build
+temp
+__pycache__
+*.egg-info
+dist
+
+
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Neucrack
+Copyright (c) 2021 Neucrack(CZD666666@gmail.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -0,0 +1,37 @@
+teedoc official website
+=====
+
+visit: [teedoc.github.io](https://teedoc.github.io)
+
+
+## build locally
+
+* Install teedoc
+
+```
+pip install teedoc
+```
+
+* Get site source files
+
+```
+git clone https://github.com/teedoc/teedoc_site
+```
+
+* Install plugins
+
+```
+cd teedoc_site
+teedoc install
+```
+
+* build and serve
+
+```
+teedoc build
+teedoc serve
+```
+
+then visit [http://127.0.0.1:2333](http://127.0.0.1:2333)
+
+
diff --git a/docs/develop/en/README.md b/docs/develop/en/README.md
diff --git a/docs/develop/en/config.json b/docs/develop/en/config.json
@@ -0,0 +1,70 @@
+{
+    "navbar": {
+        "title": "teedoc",
+        "logo": {
+            "alt": "teedoc logo",
+            "src": "/static/image/logo.png"
+        },
+        "home_url": "/en",
+        "items": [
+            {
+                "url": "/get_started/en",
+                "label": "Install",
+                "position": "left"
+            },
+            {
+                "url": "/develop/en",
+                "label": "Develop",
+                "position": "left"
+            },
+            {
+                "url": "https://github.com/neutree/teedoc",
+                "label": "github",
+                "target": "_blank",
+                "position": "right"
+            },
+            {
+                "label": "Language: ",
+                "position": "right",
+                "items": [
+                    {
+                        "url": "/develop/zh",
+                        "label": "中文"
+                    },
+                    {
+                        "url": "/develop/en",
+                        "label": "English"
+                    }
+                ]
+            }
+        ]
+    },
+    "footer":{
+        "items":[
+            {
+                "url": "https://github.com/neutree/teedoc",
+                "label": "github",
+                "target": "_blank",
+                "position": "left"
+            },
+            {
+                "url": "https://neucrack.com",
+                "label": "neucrack",
+                "target": "_blank",
+                "position": "right"
+            },
+            {
+                "url": "https://beian.miit.gov.cn",
+                "label": "*ICP备********号-1",
+                "target": "_blank",
+                "position": "middle"
+            },
+            {
+                "url": "https://beian.miit.gov.cn/#/Integrated/index",
+                "label": "*公网安备**************号",
+                "target": "_blank",
+                "position": "middle"
+            }
+        ]
+    }
+}
diff --git a/docs/develop/en/sidebar.json b/docs/develop/en/sidebar.json
@@ -0,0 +1,9 @@
+{
+    "items":[
+        {
+            "label": "teedoc development",
+            "file": "README.md"
+        }
+    ]
+}
+
diff --git a/docs/develop/zh/README.md b/docs/develop/zh/README.md
@@ -0,0 +1,58 @@
+开发 teedoc
+===========
+
+
+## 获得源码
+
+```
+git clone https://github.com/Neutree/teedoc
+```
+
+## 安装环境
+
+```
+cd teedoc
+pip install -r requirements.txt
+```
+
+
+
+## 运行源码
+
+* 安装插件
+
+```
+python teedoc/teedoc_main.py  -p examples/teedoc_site install
+```
+
+* 运行
+
+```
+python teedoc/teedoc_main.py  -p examples/teedoc_site build
+python teedoc/teedoc_main.py  -p examples/teedoc_site serve
+```
+
+* 插件导入问题和更新调试问题
+
+在`site_config.json`中设置插件的本地路径，比如：
+```json
+"teedoc-plugin-markdown-parser":{
+            "from": "../../plugins/teedoc-plugin-markdown-parser"
+        }
+```
+然后在运行时将会优先从这个路径导入包（将这个路径加入`sys.path`，然后导入），而不是系统路径，可以保证修改及时生效
+
+
+
+
+## 调试
+
+在 vscode 中调试，直接调试单文件 `teedoc_debug.py` 文件即可
+
+
+
+
+
+
+
+
diff --git a/docs/develop/zh/config.json b/docs/develop/zh/config.json
@@ -0,0 +1,70 @@
+{
+    "navbar": {
+        "title": "teedoc",
+        "logo": {
+            "alt": "teedoc logo",
+            "src": "/static/image/logo.png"
+        },
+        "home_url": "/",
+        "items": [
+            {
+                "url": "/get_started/zh",
+                "label": "安装使用",
+                "position": "left"
+            },
+            {
+                "url": "/develop/zh",
+                "label": "开发",
+                "position": "left"
+            },
+            {
+                "url": "https://github.com/neutree/teedoc",
+                "label": "github",
+                "target": "_blank",
+                "position": "right"
+            },
+            {
+                "label": "语言: ",
+                "position": "right",
+                "items": [
+                    {
+                        "url": "/develop/zh",
+                        "label": "中文"
+                    },
+                    {
+                        "url": "/develop/en",
+                        "label": "English"
+                    }
+                ]
+            }
+        ]
+    },
+    "footer":{
+        "items":[
+            {
+                "url": "https://github.com/neutree/teedoc",
+                "label": "github",
+                "target": "_blank",
+                "position": "left"
+            },
+            {
+                "url": "https://neucrack.com",
+                "label": "neucrack",
+                "target": "_blank",
+                "position": "right"
+            },
+            {
+                "url": "https://beian.miit.gov.cn",
+                "label": "*ICP备********号-1",
+                "target": "_blank",
+                "position": "middle"
+            },
+            {
+                "url": "https://beian.miit.gov.cn/#/Integrated/index",
+                "label": "*公网安备**************号",
+                "target": "_blank",
+                "position": "middle"
+            }
+        ]
+    }
+}
diff --git a/docs/develop/zh/sidebar.json b/docs/develop/zh/sidebar.json
@@ -0,0 +1,9 @@
+{
+    "items":[
+        {
+            "label": "teedoc 开发",
+            "file": "README.md"
+        }
+    ]
+}
+
diff --git a/docs/get_started/assets/images/logo.jpg b/docs/get_started/assets/images/logo.jpg
diff --git a/docs/get_started/en/README.md b/docs/get_started/en/README.md
diff --git a/docs/get_started/en/config.json b/docs/get_started/en/config.json
@@ -0,0 +1,76 @@
+{
+    "navbar": {
+        "title": "teedoc",
+        "logo": {
+            "alt": "teedoc logo",
+            "src": "/static/image/logo.png"
+        },
+        "home_url": "/en",
+        "items": [
+            {
+                "url": "/get_started/en",
+                "label": "Install",
+                "position": "left"
+            },
+            {
+                "url": "/develop/en",
+                "label": "Develop",
+                "position": "left"
+            },
+            {
+                "url": "https://github.com/neutree/teedoc",
+                "label": "github",
+                "target": "_blank",
+                "position": "right"
+            },
+            {
+                "label": "Language: ",
+                "position": "right",
+                "items": [
+                    {
+                        "url": "/get_started/zh",
+                        "label": "中文"
+                    },
+                    {
+                        "url": "/get_started/en",
+                        "label": "English"
+                    }
+                ]
+            }
+        ]
+    },
+    "footer":{
+        "items":[
+            {
+                "url": "https://github.com/neutree/teedoc",
+                "label": "github",
+                "target": "_blank",
+                "position": "left"
+            },
+            {
+                "url": "https://github.com/neutree/teedoc",
+                "label": "generated by teedoc",
+                "target": "_blank",
+                "position": "right"
+            },
+            {
+                "url": "https://neucrack.com",
+                "label": "neucrack",
+                "target": "_blank",
+                "position": "right"
+            },
+            {
+                "url": "https://beian.miit.gov.cn",
+                "label": "*ICP备********号-1",
+                "target": "_blank",
+                "position": "middle"
+            },
+            {
+                "url": "https://beian.miit.gov.cn/#/Integrated/index",
+                "label": "*公网安备**************号",
+                "target": "_blank",
+                "position": "middle"
+            }
+        ]
+    }
+}
diff --git a/docs/get_started/en/sidebar.json b/docs/get_started/en/sidebar.json
@@ -0,0 +1,9 @@
+{
+    "items":[
+        {
+            "label": "teedoc brief",
+            "file": "README.md"
+        }
+    ]
+}
+
diff --git a/docs/get_started/zh/README.md b/docs/get_started/zh/README.md
@@ -0,0 +1,33 @@
+---
+title: teedoc
+keywords: teedoc, markdown, jupyter notebook, html, 文档生成, 替代gitbook, 网站生成, 静态网站
+desc: teedoc， 将 markdown 或者 jupyter notbook 转换成 html 静态网页
+---
+
+
+将 `Markdown` 或者 `Jupyter Notebook` 格式的文档转换为 `HTML` 网页
+
+
+```python
+print("hello")
+print("hello")
+print("hello")
+```
+
+## 特性
+
+* 配置简单，环境安装简单（只需要 `Python`)
+* 支持 `Markdown` 格式的文档
+* 支持 `Jupyter Notebook` 格式的文档
+* 多文档支持
+* 多语言支持
+* 多版本支持
+* 搜索支持
+* 多级目录支持
+* `SEO` 友好
+* 实时预览修改
+* 博客支持
+* 插件支持
+* 主题支持
+
+
diff --git a/docs/get_started/zh/assets/images/logo.jpg b/docs/get_started/zh/assets/images/logo.jpg