add: all docs.

typikonbook · Jul 8, 2024 · be95cb9 · be95cb9
1 parent b43fc8a
commit be95cb9
Show file tree

Hide file tree

Showing 12 changed files with 163 additions and 74 deletions.
diff --git a/assets/.DS_Store b/assets/.DS_Store
diff --git a/assets/icon.png b/assets/icon.png
diff --git a/assets/sidebars.css → assets/typikon.css b/assets/sidebars.css → assets/typikon.css
diff --git a/chinese/index.html b/chinese/index.html
@@ -6,21 +6,24 @@
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 	<title>Typikon Book</title>
-	<meta name="description" content="Typikon name derived from Typikon 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." />
+	<meta name="description" content="Typikon name derived from Typikon 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.
+" />
 	<meta name="keywords" content="typikon,book,website,generator,static,html,css,js,theme,rust" />
 	<meta name="generator" content="typikon" />
 	<meta name="template" content="typikon-theme" />
 
 
 	<link rel="stylesheet" href="/assets/css/bootstrap.min.css">
 
-	<link rel="stylesheet" href="/assets/sidebars.css">
+	<link rel="stylesheet" href="/assets/typikon.css">
 
 	<!-- Light theme stylesheet -->
 	<link rel="stylesheet" href="/assets/light-theme.css" id="light-theme">
 	<!-- Dark theme stylesheet (initially disabled) -->
 	<link rel="stylesheet" href="/assets/dark-theme.css" id="dark-theme" disabled>
 
+	<link rel="icon" href="/assets/icon.png" type="image/png">
+
 </head>
 
 <body>

diff --git a/chinese/introduce-zh.html b/chinese/introduce-zh.html
@@ -6,21 +6,24 @@
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 	<title>Typikon Book</title>
-	<meta name="description" content="Typikon name derived from Typikon 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." />
+	<meta name="description" content="Typikon name derived from Typikon 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.
+" />
 	<meta name="keywords" content="typikon,book,website,generator,static,html,css,js,theme,rust" />
 	<meta name="generator" content="typikon" />
 	<meta name="template" content="typikon-theme" />
 
 
 	<link rel="stylesheet" href="/assets/css/bootstrap.min.css">
 
-	<link rel="stylesheet" href="/assets/sidebars.css">
+	<link rel="stylesheet" href="/assets/typikon.css">
 
 	<!-- Light theme stylesheet -->
 	<link rel="stylesheet" href="/assets/light-theme.css" id="light-theme">
 	<!-- Dark theme stylesheet (initially disabled) -->
 	<link rel="stylesheet" href="/assets/dark-theme.css" id="dark-theme" disabled>
 
+	<link rel="icon" href="/assets/icon.png" type="image/png">
+
 </head>
 
 <body>

diff --git a/chinese/quickstart-zh.html b/chinese/quickstart-zh.html
@@ -6,21 +6,24 @@
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 	<title>Typikon Book</title>
-	<meta name="description" content="Typikon name derived from Typikon 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." />
+	<meta name="description" content="Typikon name derived from Typikon 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.
+" />
 	<meta name="keywords" content="typikon,book,website,generator,static,html,css,js,theme,rust" />
 	<meta name="generator" content="typikon" />
 	<meta name="template" content="typikon-theme" />
 
 
 	<link rel="stylesheet" href="/assets/css/bootstrap.min.css">
 
-	<link rel="stylesheet" href="/assets/sidebars.css">
+	<link rel="stylesheet" href="/assets/typikon.css">
 
 	<!-- Light theme stylesheet -->
 	<link rel="stylesheet" href="/assets/light-theme.css" id="light-theme">
 	<!-- Dark theme stylesheet (initially disabled) -->
 	<link rel="stylesheet" href="/assets/dark-theme.css" id="dark-theme" disabled>
 
+	<link rel="icon" href="/assets/icon.png" type="image/png">
+
 </head>
 
 <body>
@@ -124,13 +127,14 @@ <h2>快速入门</h2>
 <p>最后刷新环境变量，使 typikon 能被正常使用。</p>
 <hr />
 <h2>快速开始</h2>
-<p>在 typikon 程序中提供了 3 个子命令，分别为 <code>init</code> 用来初始化工作目录， <code>build</code> 用来构建生成静态文件， <code>help</code> 智能化子命令帮助信息提示，当 <code>typikon</code> 主程序运行起来后结果如下：</p>
+<p>在 typikon 程序中提供了 4 个子命令，分别为 <code>init</code> 用来初始化工作目录， <code>build</code> 用来构建生成静态文件，<code>serve</code> 用来启动静态 HTTP 服务器提供预览功能， <code>help</code> 智能化子命令帮助信息提示，当 <code>typikon</code> 主程序运行起来后结果如下：</p>
 <pre><code class="language-shell">$: typikon
+
   _             _ _
  | |_ _  _ _ __(_) |_____ _ _
  |  _| || | '_ \ | / / _ \ ' \
   \__|\_, | .__/_|_\_\___/_||_|
-      |__/|_|     v0.1.1-beta
+      |__/|_|     v0.1.2
 
 Typikon lets you use markdown to write your online books.
 GitHub: http://typikonbook.github.io  License: Apache2.0
@@ -141,15 +145,16 @@ <h2>快速开始</h2>
 The commands are:
 
     init      Initialize to working directory
+    serve     Serve starting the static http server
     build     Builder static html file and output to book
 
 Use typikon help &lt;command&gt; for more information about a command.
+
 </code></pre>
 <p>在编写你的书籍资料之前，需要一个干净的目录作为 <code>typikon</code> 的工作目录，执行以下命令可以创建新的目录并且初始化为工作目录：</p>
 <pre><code class="language-shell">$: mkdir example &amp;&amp; cd example &amp;&amp; typikon init
 </code></pre>
-<p>当初始化完成之后，默认的工作目录就为 <code>example</code> 目录，在 <code>example</code> 目录中有几个关键的子目录和文件，我们只关注 <code>settings.yml</code> 文件和 <code>root.yml</code> 文件。在 <code>root.yml</code> 文件中编写 markdown 文件到书籍目录的映射关系，
-例如下面：</p>
+<p>当初始化完成之后，默认的工作目录就为 <code>example</code> 目录，在 <code>example</code> 目录中有几个关键的子目录和文件，我们只关注 <code>settings.yml</code> 文件和 <code>root.yml</code> 文件。在 <code>root.yml</code> 文件中编写 markdown 文件到书籍目录的映射关系，例如下面：</p>
 <pre><code class="language-yaml"># Book root path mapping file
 root:
   index: "index.md"
@@ -223,6 +228,20 @@ <h3>部署文件</h3>
 Ready for changes
 </code></pre>
 <p>访问 <code>http://127.0.0.1:8080</code> 就可以预览到网站。</p>
+<hr />
+<h2>内置服务</h2>
+<p>在新版本 <code>v0.1.2</code> 版本之后已经内置了 HTTP 静态服务器，可以提供预览功能，使用 <code>serve</code> 目录就可以启动静态 HTTP 服务器，默认监听端口为 <code>2478</code> ，浏览器访问 <code>http://127.0.0.1:2478</code> ：</p>
+<pre><code class="language-shell">  _             _ _
+ | |_ _  _ _ __(_) |_____ _ _
+ |  _| || | '_ \ | / / _ \ ' \
+  \__|\_, | .__/_|_\_\___/_||_|
+      |__/|_|     v0.1.2
+
+Typikon lets you use markdown to write your online books.
+GitHub: http://typikonbook.github.io  License: Apache2.0
+
+[INFO]   2024/07/08 14:32:04 💬 Starting HTTP server on port 2478
+</code></pre>
 
 				</div>
 			</div>

diff --git a/chinese/settings-zh.html b/chinese/settings-zh.html
@@ -6,21 +6,24 @@
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 	<title>Typikon Book</title>
-	<meta name="description" content="Typikon name derived from Typikon 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." />
+	<meta name="description" content="Typikon name derived from Typikon 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.
+" />
 	<meta name="keywords" content="typikon,book,website,generator,static,html,css,js,theme,rust" />
 	<meta name="generator" content="typikon" />
 	<meta name="template" content="typikon-theme" />
 
 
 	<link rel="stylesheet" href="/assets/css/bootstrap.min.css">
 
-	<link rel="stylesheet" href="/assets/sidebars.css">
+	<link rel="stylesheet" href="/assets/typikon.css">
 
 	<!-- Light theme stylesheet -->
 	<link rel="stylesheet" href="/assets/light-theme.css" id="light-theme">
 	<!-- Dark theme stylesheet (initially disabled) -->
 	<link rel="stylesheet" href="/assets/dark-theme.css" id="dark-theme" disabled>
 
+	<link rel="icon" href="/assets/icon.png" type="image/png">
+
 </head>
 
 <body>
@@ -110,27 +113,38 @@
 				<div id="markdown-content">
 					<h2>Settings</h2>
 <p>在 <code>settings.yml</code> 文件中存储是 typikon 程序默认配置文件，可以设置 typikon 渲染出来的静态网站元数据信息，例如方便 SEO 优化的 <code>description</code> 和 <code>keywords</code> 字段，<code>title</code> 用来设置书名，其他字段用于设置作者信息。</p>
-<pre><code class="language-yaml">settings:
-  about:
-    title: Typikon Book
-    author: Leon Ding
-    description: Typikon name derived from Typikon 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.
-    language: en
-    keywords: typikon,book,website,generator,static,html,css,js,theme,rust
+<pre><code class="language-yaml">title: Typikon Book
+author: Leon Ding
+description: &gt;
+  Typikon name derived from Typikon 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.
+language: en
+keywords: 'typikon,book,website,generator,static,html,css,js,theme,rust'
+directory:
+  theme: theme
+  input: book
+  output: docs
+icon: ''
+port: 2478
+theme: typikon-theme
+custom_css:
+  - /assets/css/bootstrap.min.css
+  - /assets/typikon.css
+custom_js:
+  - /assets/js/bootstrap.min.js
+  - /assets/js/bootstrap.bundle.js
 </code></pre>
-<p>在 <code>directory</code> 节点下可以设置默认，数据文件存储位置的目录和文件夹，必须是当前目录下的，可以配置目录映射关系：</p>
+<p>在 <code>directory</code> 节点下可以设置默认数据文件存储位置的文件夹和被渲染之后的时间存储文件夹，以及主题存放的文件夹；都必须是当前目录下的，可以配置目录映射关系：</p>
 <pre><code class="language-yaml">  directory:
     theme: theme
-    source: book
+    input: book
     output: docs
 </code></pre>
-<blockquote>
-<p>所有字段必须都是 <code>settings</code> 字段子节点。</p>
-</blockquote>
 <hr />
 <h2>Theme</h2>
-<p>默认 typikon 程序上支持主题文件自定义的，主题文件存储在 <code>theme</code> 目录中，你只需要修改默认的 <code>index.html</code> 内容就可以到达修改其主题的目的，<code>assets</code> 目录中存储是主题依赖资源文件。默认情况不建议去修改主题文件，如果你有前端基础可以对该目录中的文件进行修改。</p>
-<p>在 <code>settings.yml</code> 文件有关于主题的 <code>theme</code> 字段，通过修改字段来支持其他主题样式，可以自定义 css 文件和 js 文件，只需要将其放入 <code>assets</code> 文件夹目录中，添加对应映射关系即可：</p>
+<p>默认 typikon 程序上是支持主题文件自定义的，主题文件存储在 <code>theme</code> 目录中，你只需要修改默认的 <code>index.html</code> 内容就可以到达修改其主题的目的，<code>assets</code> 目录中存储是主题依赖资源文件。默认情况不建议去修改主题文件，如果你有前端基础可以对该目录中的文件进行修改。</p>
+<p>在 <code>settings.yml</code> 文件有关于主题的 <code>theme</code> 字段，通过修改字段来支持其他主题样式，字段的值对应 <code>theme</code> 目录下的主题文件夹的名称；也可以自定义 css 文件和 js 文件，只需要将其放入 <code>assets</code> 文件夹目录中，添加对应映射关系即可：</p>
 <pre><code class="language-yaml">    theme: typikon-theme
 
     custom_css:
@@ -141,7 +155,12 @@ <h2>Theme</h2>
         - /assets/js/bootstrap.min.js
         - /assets/js/bootstrap.bundle.js
 </code></pre>
-<p>如果你的网站需要统计用户访问数据，例如 Google Analytics 对 js 文件，可以通过此种方式进行自定义配置引入。</p>
+<p>例如你的网站需要统计用户访问数据，例如 Google Analytics 的 JS 代码文件，可以通过此种方式进行自定义配置引入。</p>
+<p>另外如果要自定义网页浏览器栏的 <code>icon</code> 图标可以通过修改 <code>icon</code> 字段进行配置，默认静态服务器端口也在此进行配置：</p>
+<pre><code class="language-yaml">icon: ''
+port: 2478
+</code></pre>
+<p>到此你看完所有入门教程，现在可以动手搭建专属于你的书籍在线网站了。</p>
 
 				</div>
 			</div>

diff --git a/english/index.html b/english/index.html
@@ -6,21 +6,24 @@
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 	<title>Typikon Book</title>
-	<meta name="description" content="Typikon name derived from Typikon 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." />
+	<meta name="description" content="Typikon name derived from Typikon 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.
+" />
 	<meta name="keywords" content="typikon,book,website,generator,static,html,css,js,theme,rust" />
 	<meta name="generator" content="typikon" />
 	<meta name="template" content="typikon-theme" />
 
 
 	<link rel="stylesheet" href="/assets/css/bootstrap.min.css">
 
-	<link rel="stylesheet" href="/assets/sidebars.css">
+	<link rel="stylesheet" href="/assets/typikon.css">
 
 	<!-- Light theme stylesheet -->
 	<link rel="stylesheet" href="/assets/light-theme.css" id="light-theme">
 	<!-- Dark theme stylesheet (initially disabled) -->
 	<link rel="stylesheet" href="/assets/dark-theme.css" id="dark-theme" disabled>
 
+	<link rel="icon" href="/assets/icon.png" type="image/png">
+
 </head>
 
 <body>

diff --git a/english/introduce.html b/english/introduce.html
@@ -6,21 +6,24 @@
 	<meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 	<title>Typikon Book</title>
-	<meta name="description" content="Typikon name derived from Typikon 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." />
+	<meta name="description" content="Typikon name derived from Typikon 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.
+" />
 	<meta name="keywords" content="typikon,book,website,generator,static,html,css,js,theme,rust" />
 	<meta name="generator" content="typikon" />
 	<meta name="template" content="typikon-theme" />
 
 
 	<link rel="stylesheet" href="/assets/css/bootstrap.min.css">
 
-	<link rel="stylesheet" href="/assets/sidebars.css">
+	<link rel="stylesheet" href="/assets/typikon.css">
 
 	<!-- Light theme stylesheet -->
 	<link rel="stylesheet" href="/assets/light-theme.css" id="light-theme">
 	<!-- Dark theme stylesheet (initially disabled) -->
 	<link rel="stylesheet" href="/assets/dark-theme.css" id="dark-theme" disabled>
 
+	<link rel="icon" href="/assets/icon.png" type="image/png">
+
 </head>
 
 <body>