Skip to content

Commit

Permalink
updates for titles and structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Eugeon authored Oct 31, 2023
1 parent 2fd1660 commit 9cc6d13
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 19 deletions.
17 changes: 14 additions & 3 deletions docs/en/about.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
# Basic "About page"

This is example for basic documenation project.
This is an example for basic documenation project.
It contains simple structure with couple of pages (this page, another page) and nested sub-section.

Diplodoc provides you with unique name how this project can be reached on https://diplodoc.com like
"https://common---gh-aje0e4eg9hffg001r5e5.viewer.diplodoc.com/en/"

If you would like to extend your project - please refer to [YFM Project Organization guide](https://diplodoc.com/docs/en/project/)

All changes for this project can be done within you public github repository called "diplodoc-example/docs".
To make changes and apply them:

- go to your repo under "diplodoc-example/docs"
- make changes for project structure or content
- commit & push into your repository
- go to "Actions" tab for docs repository
- run "Release" action and wait till completion
- done, updates should be available for everyone.


Diplodoc provides you with unique name how this project can be reached on diplodoc.com like
"https://common---gh-aje0e4eg9hffg001r5e5.viewer.diplodoc.com/en/" . In case if you would like to make proxy from your own domain to this Documentation - please [Contact Us](https://diplodoc.com/#contact) - we will support you accordingly untill appropriate documentation creation.
In case if you would like to make proxy from your own domain to this Documentation - please [Contact Us](https://diplodoc.com/#contact) - we will support you accordingly till appropriate documentation creation.

10 changes: 5 additions & 5 deletions docs/en/index.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
title: Documentation Template
links:
- title: sub-section
href: sub-section/
- title: about
- title: About
href: about.md
- title: page
- title: Diplodoc page on index page
href: page.md
- title: anotherpage
- title: YFM Structure on index page
href: anotherpage.md
- title: Sub-section on index page
href: sub-section/
2 changes: 1 addition & 1 deletion docs/en/sub-section/content.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sub-Section with content

This is an example page for demonstation how sub-sections can be organized.
More details about subsections inclusion can be found at https://diplodoc.com/docs/en/project/toc
More details about subsections inclusion can be found [here](https://diplodoc.com/docs/en/project/toc)
4 changes: 2 additions & 2 deletions docs/en/sub-section/index.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
title: sub-section
title: Sub-section Example on index page
links:
- title: content
- title: Content on a page under Sub-section
href: content.md
4 changes: 2 additions & 2 deletions docs/en/sub-section/toc.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
title: sub-section
title: Sub-section Example TOC
href: index.yaml
items:
- name: content
- name: Content page under sub-section
href: content.md
12 changes: 6 additions & 6 deletions docs/en/toc.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
title: Documentation Project Template
href: index.yaml
items:
- name: Sub-Section
include:
path: sub-section/toc.yaml
mode: link
items:
- name: About
href: about.md
- name: Additional page
href: page.md
- name: Another page
href: anotherpage.md
href: anotherpage.md
- name: Sub-Section
include:
path: sub-section/toc.yaml
mode: link

0 comments on commit 9cc6d13

Please sign in to comment.