From c91f0bc219c5d0af8b76e7817eee95017d3cf370 Mon Sep 17 00:00:00 2001 From: Antonio Pagano Date: Wed, 17 Jan 2024 13:41:29 -0500 Subject: [PATCH] task: getting started with the meta file --- docs/customization/meta_file.md | 51 +++++++++++++++++++++++++++++++++ internal/style.css | 9 ++++-- 2 files changed, 58 insertions(+), 2 deletions(-) diff --git a/docs/customization/meta_file.md b/docs/customization/meta_file.md index e69de29..036093b 100644 --- a/docs/customization/meta_file.md +++ b/docs/customization/meta_file.md @@ -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" +---- +``` diff --git a/internal/style.css b/internal/style.css index 52e46fd..1127818 100644 --- a/internal/style.css +++ b/internal/style.css @@ -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,