summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: f96f7ee)
raw | patch | inline | side by side (parent: f96f7ee)
| author | elektrischerwalfisch <mail@elektrischerwalfisch.de> | |
| Fri, 11 Apr 2025 20:18:57 +0000 (22:18 +0200) | ||
| committer | elektrischerwalfisch <mail@elektrischerwalfisch.de> | |
| Fri, 11 Apr 2025 20:18:57 +0000 (22:18 +0200) |
| README.md | patch | blob | history | |
| pages-de/home.md | patch | blob | history | |
| pages-en/01-header.md | patch | blob | history | |
| pages-en/markdown.md | [deleted file] | patch | blob | history |
| pages-en/shortcode-examples.md | patch | blob | history |
diff --git a/README.md b/README.md
index 8f9312972ac1ec20a9dce93481669b67e61d6acc..0d0c0c6b4262dfaecc308afc621fa9729c995aed 100644 (file)
--- a/README.md
+++ b/README.md
```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.
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 <head> section of the generated HTML page.
We are committed to providing the best services...
-- 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.
+- **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:
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 6a6879b27278a40528b3203f80296ac57be405d8..868859bf41f6226408834179774bd1556bdc814e 100644 (file)
--- a/pages-de/home.md
+++ b/pages-de/home.md
# Home
-...
+Gehe zu [englischer Homepage](/en)
diff --git a/pages-en/01-header.md b/pages-en/01-header.md
index 1d40b7807e10e239855b15e64f1727a218026bb5..898db4f398917956ad38e6f837a7717635ee0a05 100644 (file)
--- a/pages-en/01-header.md
+++ b/pages-en/01-header.md
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
--- 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>
-
index 0c18d7694851d5ce3f301c0affc2f0c53aa45031..39419a8d40908546e35eca3182b486873b506250 100644 (file)
-# Shortcodes
+# Shortcode-Examples
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