-
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.
task: getting started with the meta file
- Loading branch information
1 parent
8c3d9a0
commit c91f0bc
Showing
2 changed files
with
58 additions
and
2 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 |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
index: 0 | ||
--- | ||
|
||
The root `_meta.md` file contains the configuration for the global documentation features. By default, it contains the following: | ||
|
||
```markdown | ||
---- | ||
# Name of the website, is used on the pages description and | ||
# In the meta tags. | ||
name: Doco | ||
description: "Doco is a CLI tool to generate static documentation websites from markdown files." | ||
keywords: "keywords,for,seo" | ||
|
||
# Index defines where the pages in the root will be positioned. | ||
index: -1 | ||
|
||
logo: "/assets/logo.png" | ||
favicon: "/assets/favicon.png" | ||
|
||
|
||
# Announcement is shown on the top of the site | ||
# next to the site logo | ||
announcement: | ||
text: "Check our Github repository" | ||
link: "https://github.com/paganotoni/doco" | ||
|
||
# Social links are shown on the top right of the site | ||
github: "https://github.com/paganotoni/doco" | ||
|
||
# External links go in the top navigation bar. | ||
external_links: | ||
- text: "Documentation" | ||
link: "/" | ||
|
||
# QuickLinks go on top of the left navigation bar and | ||
# show on the quick search modal by default. Icons use google material icons | ||
# so you can there use any of the icon names from https://fonts.google.com/icons. | ||
quick_links: | ||
- text: "Documentation" | ||
link: "/" | ||
icon: "menu_book" | ||
- text: "Repository" | ||
link: "https://github.com/paganotoni/doco" | ||
icon: "code" | ||
|
||
# Shows on each of the documentation pages | ||
# $YEAR is replaced with the current year. | ||
copy: "© $YEAR Doco" | ||
---- | ||
``` |
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