From d6f0bd13ddfadb4b6c17ee93ef395953f7af1e94 Mon Sep 17 00:00:00 2001 From: elektrischerwalfisch Date: Fri, 11 Apr 2025 22:18:57 +0200 Subject: [PATCH] change content --- README.md | 13 +++++----- pages-de/home.md | 2 +- pages-en/01-header.md | 3 +-- pages-en/markdown.md | 45 ---------------------------------- pages-en/shortcode-examples.md | 10 +++++++- 5 files changed, 18 insertions(+), 55 deletions(-) delete mode 100644 pages-en/markdown.md diff --git a/README.md b/README.md index 8f93129..0d0c0c6 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,8 @@ Set up **single** or **multi-language setup** in `index.php`: ```php // Default: multilingual setup -// If your site is a single-language setup, change 'config-multilang.php' to 'config-basic.php' in the next line +// If your site is a single-language setup, +// change 'config-multilang.php' to 'config-basic.php' in the next line require 'config-multilang.php'; ``` After that you can also delete the config-file which you are not using - only one of the two config-files is needed. @@ -74,7 +75,7 @@ This file is the default startpoint of your website. Edit this file to change the error-message which is shown if a page is not found. -## Meta information (Title, Description & Robots) +## Meta information Each Markdown page can include optional meta information using HTML comments at the top of the file. These values will be automatically extracted and used in the section of the generated HTML page. @@ -88,9 +89,9 @@ Example Markdown file (about.md) with meta information: We are committed to providing the best services... -- title → Sets the `` of the page. Defaults to the filename if not provided. -- description → Used for the `<meta name="description">` tag (important for SEO). Defaults to an empty string if not set. -- robots → Controls search engine indexing (index, follow / noindex, nofollow). Defaults to index, follow. +- **title** → Sets the `<title>` of the page. Defaults to the filename if not provided. +- **description** → Used for the `<meta name="description">` tag (important for SEO). Defaults to an empty string if not set. +- **robots** → Controls search engine indexing (index, follow / noindex, nofollow). Defaults to index, follow. ## Shortcodes flatMark supports simple shortcodes for structured content. Some examples: @@ -107,7 +108,7 @@ flatMark supports simple shortcodes for structured content. Some examples: These shortcodes are part of the theme and are all located in the file `/theme/shortcodes.php`. You can edit this file to change existing shortcodes or add even more. -An example-page with all shortcodes is provided with the installation: `/pages-en/shortcodes.md` +An example-page with all shortcodes is provided with the installation: `/pages-en/shortcode-examples.md` ## Customization diff --git a/pages-de/home.md b/pages-de/home.md index 6a6879b..868859b 100644 --- a/pages-de/home.md +++ b/pages-de/home.md @@ -1,4 +1,4 @@ # Home -... +Gehe zu [englischer Homepage](/en) diff --git a/pages-en/01-header.md b/pages-en/01-header.md index 1d40b78..898db4f 100644 --- a/pages-en/01-header.md +++ b/pages-en/01-header.md @@ -9,6 +9,5 @@ A lightweight, flat-file Markdown-based website generator - [Home](/en/home) -- [Shortcodes](/en/shortcodes) -- [Markdown](/en/markdown) +- [Shortcode-Examples](/en/shortcode-examples) - [Contact](/en/contact) \ No newline at end of file diff --git a/pages-en/markdown.md b/pages-en/markdown.md deleted file mode 100644 index 8904e49..0000000 --- a/pages-en/markdown.md +++ /dev/null @@ -1,45 +0,0 @@ -# Examples - -Find the full markdown-syntax here: [www.markdownguide.org/basic-syntax](https://www.markdownguide.org/basic-syntax/) - -Some basic examples: - -{columns 50-50} - -**Code:** - -{code} -## headline 2 -### headline 3 -**bold text** - -- List item one -- List item two -- List item three - ---- -[Linktext](http://www.domain.de) -{/code} - -{columns-seperator} - -**Html-output:** - -## headline 2 -### headline 3 -**bold text** - -- List item one -- List item two -- List item three - ---- -[Linktext](http://www.domain.de) - -{/columns} - -For a simple line-break just add two empty spaces after the last word in the line. -For a second empty line add `<br>` - -<br> - diff --git a/pages-en/shortcode-examples.md b/pages-en/shortcode-examples.md index 0c18d76..39419a8 100644 --- a/pages-en/shortcode-examples.md +++ b/pages-en/shortcode-examples.md @@ -1,4 +1,4 @@ -# Shortcodes +# Shortcode-Examples These shortcodes are available by default in the flatMark-theme: @@ -24,6 +24,14 @@ These shortcodes are available by default in the flatMark-theme: {year} Output of the current year (Can be used for copyright in 02-footer.md) +{code} + Used only in this documentation to display unrendered shortcodes in code-block + +{readme} + Outputs the readme.md from the root-folder. + Used on the default-page /pages-en/home.md + + {/code} ### Additional values -- 2.47.3