Skip to content

Commit

Permalink
task: getting started with the meta file
Browse files Browse the repository at this point in the history
  • Loading branch information
paganotoni committed Jan 17, 2024
1 parent 8c3d9a0 commit c91f0bc
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 2 deletions.
51 changes: 51 additions & 0 deletions docs/customization/meta_file.md
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"
----
```
9 changes: 7 additions & 2 deletions internal/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,13 @@

#htmlcontainer pre {
@apply inline overflow-auto;

white-space: nowrap; /* Allows textarea to scroll horizontally */

white-space: pre-wrap; /* css-3 */
white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
white-space: -pre-wrap; /* Opera 4-6 */
white-space: -o-pre-wrap; /* Opera 7 */
word-wrap: break-word; /* Internet Explorer 5.5+ */

}

#htmlcontainer h1,
Expand Down

0 comments on commit c91f0bc

Please sign in to comment.