1 Star 0 Fork 4

diator / Wiki

forked from mixly / Wiki 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Mixly Wiki

Mixly Wiki 编写准备

注册gitee账号

https://gitee.com

安装github同步软件github-desktop

https://desktop.github.com/

安装好用的文本编辑器sublime

http://www.sublimetext.com/

克隆项目到本地

编写项目

  • 打开github-desktop 软件,依次点击Repository-open in sublime Text,用sublime打开该项目进行编辑。

项目目录说明

|--doc
   |--build  /*生成目录*/
      |--doctrees
      |--gettext /*语言包字段目录*/
      |--html /*本地预览目录*/
        |--index.html /*本地预览页面*/
   |--source /*源文件目录*/
      |--_static /*静态html文件目录*/
      |--_templates /*自定义模板目录*/
      |--Arduino /*Arduino部分wiki目录*/
        |--AVR /*Arduino AVR 部分wiki*/
          |--images /*引用图片*/
            |--01Input-Output/*输入、输出类别图片*/
              |-- analogRead.png /*所有图片都用png格式,文件命名格式为该函数名*/
              |-- analogRead-example.png /*模块使用范例截图*/
              |-- analogRead.en.png /*analogRead.png对应的英文图片*/
              |-- analogRead-example.en.png /*analogRead-example.png对应的英文图片*/
            |--01Input-Output.rst /*输入\输出的wiki文件*/
        |--ESP32 /*ESP32 部分wiki*/
      |--basic /*软件基础部分wiki目录*/
      |--locale /*多语言目录*/
        |--en   /*英文语言翻译文件*/
      |--MicroPython /*micropython部分wiki目录*/
      |--Python /*python部分wiki目录*/

以 arduino/AVR为例进行目录说明,arduino/AVR目录中包含多个rst文件,rst为wiki的核心文件,通过编辑该类文件创建wiki。

在编写mixly wiki过程中可以参考 arduino语法。

编写wiki所使用rst文档采用的是Sphinx,常用语法可以参考下面链接。 https://zh-sphinx-doc.readthedocs.io/en/latest/contents.html

Arduino 语法参考

http://www.cnblogs.com/xczr/p/7832015.html

https://www.arduino.cc/reference/en/

wiki编写说明

根据mixly模块顺序,介绍每一个模块。包括截图、描述、参数、返回值、范例、注释(注意点)。

编写文件可以参考source\Arduino\AVR\01Input-Output.rst

显示效果可以参考 https://mixly.readthedocs.io/zh_CN/latest/arduino/02.Input-Output.html

提交代码

修改文本后,按照下图操作提交代码。

本地预览

  • 安装python3.x
  • 打开cmd,输入以下命令,配置基础环境
pip install -U Sphinx
pip install sphinx_rtd_theme
pip install --upgrade recommonmark
  • 跳转到本地项目路径,执行生成命令
cd Documents\GitHub\mixly_wiki\doc
make html

  • 打开build/html/index.html,查看本地预览。

在线预览

在提交代码之后,浏览https://mixly.readthedocs.io/zh_CN/latest/

翻译wiki

安装sphinx-intl.

pip install sphinx-intl

生成pot文件

运行以下命令生成pot文件 windows系统下,注意后面的命令都是在doc目录下进行的。

cd doc
make.bat gettext

或者直接

.\doc\make.bat gettext

如果提示

Extension error:
Could not import recommonmark.parser (needed for source parser) (exception: No module named 'recommonmark')

那么请运行 pip install recommonmark就可以了。 运行完成后会生成新目录 :doc/build/gettext

生成英文翻译文件

sphinx-intl update -p build/gettext -l en

执行完成后,产生如下目录 source/locale/en/LC_MESSAGES/

翻译po文件

打开source/locale/en/LC_MESSAGES/目录下的po文件,进行翻译。

如原始:

#: ../../source/arduino/AVR/01Input-Output.rst:2
msgid "输入/输出"
msgstr ""

翻译后:

#: ../../source/arduino/AVR/01Input-Output.rst:2
msgid "输入/输出"
msgstr "Input/Output"

即,msgid为翻译前语言的内容,msgstr为翻译后语言的内容。

编译html文档

set SPHINXOPTS=-D language=en
.\make.bat html

查看最终效果

将文档提交到github,打开wiki页面,https://mixly.readthedocs.io

左下角打开功能框,切换到en,查看效果。

支持pdf导出(高级应用)

Mac 配置环境

Sphinx 生成 PDF 的过程先将 rst 转换为 tex,再生产PDF。这个过程遇到了比较多的坑,最后总结下来过程如下: 首先,安装 Tex 环境。在 Mac 上,推荐安装 MacTex 而不是 BasicTex,对于新手来说 BasicTex 上需要自己处理很多以来问题。完成后使用 tlmgr 更新 TexLive。

$ brew cask install mactex $ sudo tlmgr update --self

然后,在 conf.py 中设置 latex_engine 和 latex_elements 两个参数。

latex_engine = 'xelatex'
latex_elements = {
    'papersize': 'a4paper',
    'pointsize': '11pt',
    'preamble': r'''
\usepackage{xeCJK}
\setCJKmainfont[BoldFont=STZhongsong, ItalicFont=STKaiti]{STSong}
\setCJKsansfont[BoldFont=STHeiti]{STXihei}
\setCJKmonofont{STFangsong}
\XeTeXlinebreaklocale "zh"
\XeTeXlinebreakskip = 0pt plus 1pt
\parindent 2em
\definecolor{VerbatimColor}{rgb}{0.95,0.95,0.95}
\setcounter{tocdepth}{3}
\renewcommand\familydefault{\ttdefault}
\renewcommand\CJKfamilydefault{\CJKrmdefault}
'''
}

编译pdf

$ make latexpdf

make latexpdf 会完成 rst转换为 tex 并将 tex 生成 PDF,可以手动分开: $ make latex $ cd build/latex $ make

在 build/latex 下可以查看到生成的 PDF 文档。

自动预览

安装库

pip install sphinx-autobuild

运行

sphinx-autobuild source build/html

贡献者

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Mixly Wiki 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/diator/Wiki.git
git@gitee.com:diator/Wiki.git
diator
Wiki
Wiki
master

搜索帮助