Skip to content

Commit

Permalink
docs: add all docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
auula committed Jul 3, 2024
1 parent adf6d74 commit d04474a
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 13 deletions.
Binary file added .DS_Store
Binary file not shown.
2 changes: 1 addition & 1 deletion chinese/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h2>Typikon</h2>
</div>
<hr />
<h3>介 绍</h3>
<p>Typikon 的名字源自 <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> 书籍,它是一个类似于 mdbook 和 Hugo 的静态网站渲染工具,但它专注于将 Markdown 渲染成在线书籍,比其他工具更易于使用。</p>
<p>Typikon 的名字源自 <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> 书籍,它是一个类似于 mdbook 和 gitbook 的静态网站渲染工具,但它专注于将 Markdown 渲染成在线书籍,比其他工具更易于使用。</p>
<hr />
<blockquote>
<p>GitHub:<a href="https://github.com/auula/typikon">github.com/auula/typikon</a> 🌟</p>
Expand Down
2 changes: 1 addition & 1 deletion chinese/introduce-zh.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h2>Typikon</h2>
</div>
<hr />
<h3>介 绍</h3>
<p>Typikon 的名字源自 <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> 书籍,它是一个类似于 mdbook 和 Hugo 的静态网站渲染工具,但它专注于将 Markdown 渲染成在线书籍,比其他工具更易于使用。</p>
<p>Typikon 的名字源自 <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> 书籍,它是一个类似于 mdbook 和 gitbook 的静态网站渲染工具,但它专注于将 Markdown 渲染成在线书籍,比其他工具更易于使用。</p>
<hr />
<blockquote>
<p>GitHub:<a href="https://github.com/auula/typikon">github.com/auula/typikon</a> 🌟</p>
Expand Down
10 changes: 5 additions & 5 deletions chinese/quickstart-zh.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,13 @@ <h2>快速入门</h2>
<p>在使用 typikon 程序之前请确保你计算机已经成功连接到国际互联网,如果是中国大陆地区可能会出现无法创建工作目录的情况,如果出现此类问题,可以尝试使用加速或者开启代理软件,再使用 typikon 进行目录初始化工作。</p>
</blockquote>
<p>当下载好 zip 二进制软件包后,请使用 <code>unzip</code> 或者其他解压软件来解压 <code>typikon-darwin-x64-beta-v0.1.1.zip</code> 软件包,命令如下:</p>
<pre><code class="language-shell">unzip typikon-darwin-x64-beta-v0.1.1.zip -d /usr/local/typikon
<pre><code class="language-shell">unzip typikon-darwin-x64-beta-v0.1.1.zip -d /Users/dings/devsoft
</code></pre>
<p>再通过手动解压二进制到指定目录中,如果你想要全局使用 typikon 程序,那么必须将 typikon 所在的路径添加到计算机操作系统的环境变量中,例如:</p>
<pre><code class="language-shell">TYPIKON="/usr/local/typikon"
export TYPIKON
<p>通过手动解压二进制到指定目录中,如果你想要全局使用 typikon 程序,那么必须将 typikon 所在的路径添加到计算机操作系统的环境变量中,例如:</p>
<pre><code class="language-shell">export TYPIKON="/Users/dings/devsoft"
export PATH=$TYPIKON:$PATH
</code></pre>
<p>最记得刷新环境变量,使 typikon 能被正常使用。</p>
<p>最后刷新环境变量,使 typikon 能被正常使用。</p>
<hr />
<h2>快速开始</h2>
<p>在 typikon 程序中提供了 3 个子命令,分别为 <code>init</code> 用来初始化工作目录, <code>build</code> 用来构建生成静态文件, <code>help</code> 智能化子命令帮助信息提示,当 <code>typikon</code> 主程序运行起来后结果如下:</p>
Expand Down
2 changes: 1 addition & 1 deletion english/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h2>Typikon</h2>
</div>
<hr />
<h3>Introduce</h3>
<p>Typikon name derived from <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> Book, the a static website rendering tool similar to mdbook and hugo, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.</p>
<p>Typikon name derived from <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> Book, the a static website rendering tool similar to mdbook and gitbook, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.</p>
<hr />
<blockquote>
<p>GitHub: <a href="https://github.com/auula/typikon">github.com/auula/typikon</a> 🌟</p>
Expand Down
2 changes: 1 addition & 1 deletion english/introduce.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h2>Typikon</h2>
</div>
<hr />
<h3>Introduce</h3>
<p>Typikon name derived from <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> Book, the a static website rendering tool similar to mdbook and hugo, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.</p>
<p>Typikon name derived from <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> Book, the a static website rendering tool similar to mdbook and gitbook, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.</p>
<hr />
<blockquote>
<p>GitHub: <a href="https://github.com/auula/typikon">github.com/auula/typikon</a> 🌟</p>
Expand Down
6 changes: 3 additions & 3 deletions english/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,11 @@ <h2>Quick Start</h2>
<p>Before using Typikon, ensure that your computer is successfully connected to the international internet. If you are in mainland China, you may encounter issues creating a working directory. If this happens, try using acceleration or enabling proxy software before using Typikon to initialize the directory.</p>
</blockquote>
<p>After downloading the zip binary package, unzip it using <code>unzip</code> or another decompression software. For example:</p>
<pre><code class="language-shell">unzip typikon-darwin-x64-beta-v0.1.1.zip -d /usr/local/typikon
<pre><code class="language-shell">unzip typikon-darwin-x64-beta-v0.1.1.zip -d /Users/dings/devsoft
</code></pre>
<p>Then manually extract the binaries to the specified directory. If you want to use the Typikon program globally, you must add the path where Typikon is located to the environment variables of your computer’s operating system. For example:</p>
<pre><code class="language-shell">TYPIKON="/usr/local/typikon"
export TYPIKON
<pre><code class="language-shell">export TYPIKON="/Users/dings/devsoft"
export PATH=$TYPIKON:$PATH
</code></pre>
<p>Remember to refresh the environment variables to ensure that Typikon can be used properly.</p>
<hr />
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h2>Typikon</h2>
</div>
<hr />
<h3>Introduce</h3>
<p>Typikon name derived from <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> Book, the a static website rendering tool similar to mdbook and hugo, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.</p>
<p>Typikon name derived from <a href="https://en.wikipedia.org/wiki/Typikon">Typikon</a> Book, the a static website rendering tool similar to mdbook and gitbook, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.</p>
<hr />
<blockquote>
<p>GitHub: <a href="https://github.com/auula/typikon">github.com/auula/typikon</a> 🌟</p>
Expand Down

0 comments on commit d04474a

Please sign in to comment.