-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
30 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |