Adding structure for basic documentation in English

diplodoc-platform · Oct 23, 2023 · 522c007 · 522c007
1 parent 5066e0c
commit 522c007
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 1 deletion.
diff --git a/.yfm b/.yfm
@@ -1,13 +1,14 @@
 disableLiquid: true
 allowHTML: true
-langs: ['ru']
+langs: ['en','ru']
 
 resources:
   style:
     - _assets/style/custom.css
 
 docs-viewer:
   project-name: diplodoc
+  langs: ['en','ru']
   favicon-src: https://storage.yandexcloud.net/diplodoc-www-assets/favicon/favicon.ico
   github-url-prefix: https://github.com/diplodoc-platform/docs/blob/master
   logo-link-preview: https://storage.yandexcloud.net/diplodoc-www-assets/navigation/diplodoc-logo.svg

diff --git a/en/about.md b/en/about.md
@@ -0,0 +1,2 @@
+
+#TBD
diff --git a/en/how-it-work.md b/en/how-it-work.md
@@ -0,0 +1 @@
+#TBD
diff --git a/en/index-yfm.md b/en/index-yfm.md
@@ -0,0 +1 @@
+# Yandex Flavored Markdown
diff --git a/en/index.yaml b/en/index.yaml
@@ -0,0 +1,18 @@
+title: Diplodoc
+description: Diplodoc - платформа работы с документацией в парадигме Documentation as a Code. 
+meta:
+  title: Metadata
+  noIndex: true
+links:
+- title: Overview
+  description: Platform Overview, Capabilities and Benefits.
+  href: about.md
+- title: Quick Start
+  description: How to start
+  href: how-it-work.md
+- title: Yandex Flavored Markdown
+  description: Definition for Yandex Flavored Markdown.
+  href: index-yfm.md
+
+
+
diff --git a/en/toc.yaml b/en/toc.yaml
@@ -0,0 +1,9 @@
+title: Diplodoc
+href: index.yaml
+items:
+  - name: Overview
+    href: about.md
+  - name: Quick start
+    href: how-it-work.md
+  - name: Yandex Flavored Markdown  
+    href: index-yfm.md