diff --git a/pytorch-logo-dark.png b/pytorch-logo-dark.png new file mode 100644 index 0000000..b7a1ceb Binary files /dev/null and b/pytorch-logo-dark.png differ diff --git a/script/mkdocs.yml b/script/mkdocs.yml new file mode 100644 index 0000000..1b79a6e --- /dev/null +++ b/script/mkdocs.yml @@ -0,0 +1,16 @@ +site_name: Pytorch中文手册 +site_url: https://handbook.pytoech.wiki/ +repo_url: https://github.com/zergtant/pytorch-handbook/ +site_author: zergtant +site_description: pytorch handbook是一本开源的书籍,目标是帮助那些希望和使用PyTorch进行深度学习开发和研究的朋友快速入门,其中包含的Pytorch教程全部通过测试保证可以成功运行 +docs_dir: ..\ +site_dir: ..\..\html +use_directory_urls: false +theme: gitbook +plugins: + - exclude: + glob: + - script/* + - changelog-v* + - "*.ipynb" + - "*.pdf" \ No newline at end of file diff --git a/script/readme.md b/script/readme.md new file mode 100644 index 0000000..eab2f8c --- /dev/null +++ b/script/readme.md @@ -0,0 +1,28 @@ +# 生成html和markdown + +## markdown +使用以下命令可以将所有的.ipynb文件转换为markdown文件 +``` +jupyter nbconvert --to markdown .\*\*.ipynb +``` +执行完上述命令后,会为每个ipynb生成对应的markdown + + +## 通过mkdocs生成 在线文档 +需要安装mkdocs和主题gitbook,我个人比较喜欢这个主题。 +mkdocs用到了一个插件,所以也需要一起安装 +``` +pip install mkdocs +pip install mkdocs-gitbook +pip install mkdocs-exclude +``` +在script目录下直接执行 +``` +mkdocs build +``` +使用script目录中的mkdocs.yml配置即可生成web站点,可以在本地进行查看 + + +## markdown 生成pdf + +TODO \ No newline at end of file