mirror/php-typemill
1
0
Fork 0
mirror of https://github.com/typemill/typemill.git synced 2025-08-06 06:07:31 +02:00
Code Issues Releases Wiki Activity

version 1.1.5 Typemill Learns Math

Browse Source
This commit is contained in:
Sebastian
2018-05-09 18:35:36 +02:00
parent 7bf12c6fa0
commit d7069f819a
147 changed files with 923 additions and 8147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
content/0_typemill/03-features.md
View File

@@ -7,7 +7,8 @@ This is what you can **do with TYPEMILL**:
- Create a website with simple files and folders.
- Use markdown for your content files.
- Use an admin panel to configure your site.
- Choose themes and activate plugins.
- Choose themes.
- Activate plugins. Check the [list of plugins](/writers/plugins) for that.
- Create your own theme with HTML, CSS and Twig (a template language for PHP).
- Create your own plugins with PHP.

17
content/0_typemill/09-roadmap.md
View File

@@ -9,14 +9,23 @@ Here are some **milestones** of the past:
- Introduced plugins with version 1.1.0
- Added an author panel to configure the system with version 1.1.3
And here is the **roadmap** for the future:
And here is the **roadmap** for this year (2018):
- Support mathematical formulars for scientific text works.
- Add a content editor to create and edit your pages online.
- Support math in markdown for scientific text works.
- Add a basic markdown editor to manage your content online.
- Add an Image- and media-management.
- Add an advanced WYSIWYG markdown editor for a great writers experience.
- Create additional output formats like mobi, epub and pdf.
- Create a clean API.
- More themes for special publications like documentations, books or lyrics.
- Create a lot of cool plugins
- Create many useful plugins.
And this is the **vision** for the future. It requires several years of work to come true:
* Create a lightweight and self hosted one click publishing system with a great writing experience.
* Support math, data, charts, tables, umls, maps and everything you need for serious publishing.
* Add the posibility to sell and commercialize your publication in a central book-store.
* Create an exclusive add-network for typemill publishers.
* Create microservices with additional selling options.
If you miss a feature or if you found a bug, please report it on [GitHub](https://github.com/trendschau/typemill).

179
content/2_for-writers/05-mardown.md
View File

@@ -1,14 +1,12 @@
# Markdown
Never heard of Markdown? Markdown is very similar to the markup used by Wikipedia. It is a simple syntax to format headlines, lists or paragraphs in a text file. Markdown files end with `.md`.
Never heard of Markdown? Markdown is a simple syntax for text formatting and very similar to the markup used by wikipedia. Markdown uses a handful special characters like `#` of `*` to format the text.
[TOC]
The big advantage for writers: They don't have to click a button to format a headline or to create a list. Instead they can format the text during the writing process without an interruption. Once you are familiar with the syntax, you can write cleaner and faster than with any common HTML editor. For a quick start with many examples, read the [markdown reference page](/info/markdown-test).
## Simple Example
## Markdown Example
Today, Markdown is a standard formatting language used by a lot of technology platforms like GitHub or StackOverflow. And Markdown is also entering the non technical mainstream. The press releases of dpa are written in Markdown, for example.
Markdown uses some special characters like `#` or `-` to format a text. A short example:
This is a short example for a markdown text:
````
# My first level headline
@@ -20,151 +18,46 @@ This is a paragraph and now we create an unordered list:
- A last item
````
## Advantages of Markdown
From a technical point of view, markdown is cleaner, shorter and safer than HTML. At the same time, markdown can be transformed to clean HTML easily. This is why markdown is used by a lot of technology platforms like GitHub or StackOverflow. And Markdown is also entering the non technical mainstream. The press releases of dpa are written in Markdown, for example.
There are some good reasons for the rise of Markdown:
## Markdown Quick Reference
- Different to proprietary formats like word.docx, the Markdown syntax is universal and not bound to a special text software.
- You can use the most simple text editor (e.g. the "editor" of microsoft office) or a special Markdown editor like Typora to create Markdown files.
- Markdown can be transformed into a valid HTML document easily.
- Compared to the well known WISYWIG HTML editors (e.g. used by WordPress), Markdown is less hacky, more secure and the content is more reusable.
This is a quick reference table. For a detailed reference with examples, please check the [markdown reference page](/info/markdown-test).
There are also some disadvantages:
| Markdown | Result |
| ------------------------------------------------------------ | --------------------------------------- |
| `[TOC]` | Table of content |
| `#` | Headline first level |
| `######` | Headline sixth level |
| simple text | Paragraph |
| `_italic_` | Italic text |
| `*italic*` | Italic text |
| `__bold__` | Bold text |
| `**bold**` | Bold text |
| `- list item` | Unordered list |
| `* list item` | Unordered list |
| `5. ordered list` | Ordered list (use any number you want). |
| `---` | Horizontal rule |
| `[link text](http://typemill.net)` | Link |
| `![alt text](/path/to/image.jpg)` | Image |
| `> interesting quote` | Blockquote |
| `footnote[^1]`<br /> `[^1]:footnote text` | Footnote |
| `*[HTML]:Hyper Text Markup Language` | Abbreviation |
| `Apple`<br /> `: Green thingy growing on trees` | Definition list |
| `|name |usage |`<br /> `|-----------|-----------|`<br /> `| My Name | For Me |` | Table |
| ` | Inline code |
| `` | Inline math expression |
| ``` | Code block |
| ```latex | Math block |
- You cannot use a text program like Microsoft Word to create Markdown files.
- Markdown is usually not WYSIWYG and the writing experience is a bit different from Word or WordPress. However, there are a lot of Markdown editors which provide a preview window. Some editors even provide a full WYSIWYG modus (e.g. Typora).
- Markdown is not totally unified and the rendering of Markdown files can be ambiguous. There are some variations and enhancements like CommonMark or Markdown Extra.
With the following basic Markdown reference, you can learn to write Markdown in less than 10 minutes!
## Basic Markdown Reference
You can read the full specification of Markdown at [Mark Guber](http://daringfireball.net/projects/markdown/syntax), the inventor of Markdown.
### Paragraph
## Write Markdown with TYPEMILL
Just write down some text and use the return key two times for a new paragraph:
An online editor for TYPEMILL is on its way, but for time beeing, you have to create your markdown text-files offline and upload them with your favourite FTP software.
````
To create a new paragraph, just press the return button two times.
You can create markdown-files with any kind of text editor. Simply create a file with the ending `.md`. You can use any code editor, a simple text editor like the standard "editor" of Microsoft, or you can use a special markdown editor like Typora. Typora is a very clean WYSIWYG-editor that is specialized on distraction free text creation.
Then proceed writing. It is really as simple as that!
````
### Emphasis and Strong
Embed text in a `_` or `*` to create an _emphasis_ or use a `__` or `**` to create **strong** text element:
````
This is an _emphasis_ and this is a __strong__ text.
You can use asterix for an *emphasis* or a **strong** text, too.
````
### Headlines
Just use the character `#` for headlines like this:
````
# Headline (1. level)
## Headline (2. level)
### Headline (3. level)
#### Headline (4. level)
##### Headline (5. level)
###### Headline (6. level)
````
### Lists
To create an unordered `-` / `*`or ordered `1.` list, just follow your intuition:
````
This is an unordered list:
- Item
- Another item
- Last item
You can write it this way:
* Item
* Another item
* Last item
And this is an ordered list:
1. Item 1
2. Item 2
3. Item 3
````
### Blockquote
Just use the `>` to create a blockquote:
````
This is a quote by a famous woman:
> If I stop to kick every barking dog I am not going to get where I’m going.
````
### Horizontal Rule
To create a horizontal line, use `---`
````
This is a text followed by a horizontal line
---
And this is another text.
````
### Links
Use square brackets for the linked text followed by round clips for the url.
````
[Linked Text](http://url-to-a-website.com)
````
You can also use a shortcut for links `<http://www.yourlink.de>` and emails `<my@emailadress.net>`, but you cannot add a text for the links or emails with these shortcuts.
When rendered, Markdown will automatically obfuscate email adresses to help obscure your address from spambots.
### Images
Images look similar to links, simply add an ! like this:
````
![image alt text](/path/to/image.jpg)
````
### Code (inline)
To create inline code, just use the ` sign like this:
````
Inline code `<?php echo 'hello world!'; ?>` within a sentence.
````
### Code (block)
To create a code block, just indent your text with four spaces or use four ```` like this:
````
This text is followed by a code-block:
​````
<?php
$string = 'hello ';
$string .= 'world!';
echo $string;
?>
````
###Table of Contents
As of version 1.0.5 you can use the tag `[TOC]` to create a table of contents. Simply add the tag in a separate line into your document. Typemill will generate a link-list with all headlines of your text.
### Advanced Formats
You can also create more complex formats like tables, abbreviations, footnotes and special attributes. Just check the [specification of Markdown Extra](https://michelf.ca/projects/php-markdown/extra/) if you want to use these kind of formats.
For a quick reference and examples for all markdown formats you can head over to the [markdown reference page](/info/markdown-test).

9
content/2_for-writers/30-plugins.md
View File

@@ -6,10 +6,11 @@ To update a plugin, simply go to the plugin folder of TYPEMILL, delete the plugi
Right now all plugins are delivered with the core version of TYPEMILL. But as the number of plugins grows, there will probably be a central place to download and install the plugins in the future.
The core version ships with two plugins:
The core version ships with the following plugins:
* **Cookie Consent**: This plugin adds a cookie consent banner to your website. You can change the colors and the text in the plugin-settings.
* **Analytics**: This plugin adds an analytics-script for Matomo (Piwik) and Google Analytics.
* **Cookie Consent**: Adds a cookie consent banner to your website.
* **Analytics**: Adds Matomo (Piwik) or Google Analytics to your website.
* **Highlight**: Highlights code in code-blocks (useful for developers).
* **Math**: Write math with markdown and MathJax or KaTeX. Check the [markdown reference page](/info/markdown-test).
If you are a developer and if you want to create your own plugins, please refer to the [plugin documentation](/plugin-developers).

265
content/5_info/15_markdown-test.md
View File

@@ -1,58 +1,209 @@
# Test the Markdown-Styling
# Markdown Reference and Test Page
This is just a test file to check, if all the html elements created by the markdown syntax are styled correctly. If you create a new template, please use this page to check your css styling.
Markdown is a simple and universal syntax for text formatting. More and more writers switch to markdown, because they can format their text during the writing process without using any format-buttons. Once they are familiar with the markdown syntax, they can write formatted text much easier and faster than with any standard HTML-editor.
## Table of Contents
Developers love markdown, because it is much cleaner and saver than HTML. And they can easily convert markdown to a lot of other document formats like HTML and others.
You can create a table of contents with the [TOC] tag written in a separate line. The TOC-Tag will be replaced with a link-list to all headlines of the page.
If you develop a theme for TYPEMILL, please take care that all elements on this page are designed properly.
##Table of Contents
To create a table of contents, simply write `[TOC]` in a separate line. It will be replaced with a table of contents like this automatically.
[TOC]
## Inline Elements
This is an ordinary paragraph containing only simple text.
This is an _emphasis_ and this is a **bold** text. You can use asterixes to create an *emphasis* or an **bold** text, too. You can _emphasis more than one word_, but if you use it in_the_middle_of_the_word, then no emphasis will appear.
This is a footnote [^1]. Please check at the end of this file, if two footnotes[^2] appear.
This is a [Link](http://writedown.net), you can also use a shortcut to create a <http://writedown.net> without a link text.
## Headlines
We already used some first and second level headlines, but check them in combination of other headlines. Now let us use a
```
Headlines are simply done with hash chars like this:
# First Level Headline
## Second Level Headline
### Third Level Headline
#### Fourth Level Headline
##### Fifth Level Headline
###### Sixth Level Headline
```
### Third Level Headline
This headline is ligthly more decent and should be visibly lower prioritized than a second level headline.
A third headline is more decent and lower prioritized than a second level headline.
#### Fourth Level Headline
The fourth level headline will probably not used too often in usual text works, but you should still provide a design for it.
A fourth level headline is more decent and lower prioritized than a third level headline.
##### Fifth Level Headline
Yes, this is a really low level headline, probably only used by very scientific works or studies with a deep logical structure.
A fifth level headline is more decent and lower prioritized than a fourth level headline.
###### Sixth Level Headline
##### Sixth Level Headline
Finally a sixth level headline, and yes: This is really really low. But get your brain around it and provide some nice style!
A sixth level headline is more decent and lower prioritized than a fifths level headline.
## Lists
##Paragraph
This is an unordered List:
````
- One Item
- Another Item
- An Item again
A paragraph is a simple text-block separated with a new line above and below.
This is an ordered List:
````
1. First Item
2. Second Item
3. Third Item
A paragraph is a simple text-block separated with a new line above and below.
And this is a definition List:
##Emphasis
````
For italic text use one *asterix* or one _underscore_.
For bold text use two **asterix** or two __underscores__.
````
For italic text use one *asterix* or one _underscore_.
For bold text use two **asterix** or two __underscores__.
##Lists
````
For an unordered list use a dash
- like
- this
Or use one asterix
* like
* this
For an ordered list use whatever number you want and add a dot:
1. like
1. this
````
For an unordered list use a dash
- like
- this
Or use one asterix
* like
* this
For an ordered list use whatever number you want and add a dot:
1. like
2. this
## Horizontal Rule
```
Easily created for example with three dashes like this:
---
```
Easily created for example with three dashes like this:
---
##Links
````
This is an ordinary [Link](http://typemill.net).
Links can also be [relative](/info).
You can also add a [title](http://typemill.net "typemill").
You can even add [ids or classes](http://typemill.net){#myid .myclass}.
Or you can use a shortcut like http://typemill.net.
````
This is an ordinary [Link](http://typemill.net).
Links can also be [relative](/info).
You can also add a [title](http://typemill.net "typemill").
You can even add [ids or classes](http://typemill.net){#myid .myclass}.
Or you can use a shortcut like http://typemill.net.
##Images
```
The same rules as with links, but with a !
![alt-text](/info/markdown.png)
![alt-text](/info/markdown.png "my title")
![alt-text](/info/markdown.png "my title"){#myid .myclass}
```
The same rules as with links, but with a !
![alt-text](/media/markdown.png){.imgClass}
![alt-text](/media/markdown.png "my title"){.imgClass}
![alt-text](/media/markdown.png "my title"){#myid .imgClass .myClass}
## Blockquote
```
There are always some women and men with wise words
> But I usually don't read them, to be honest.
```
There always some women and men with wise words
> But I usually don't read them, to be honest.
##Footnotes
````
You can write footnotes[^1] with markdown.
Scroll down to the end of the page[^2] and look for the footnotes.
Add the footnote text at the bottom of the page like this:
[^1]: Thank you for scrolling.
[^2]: This is the end of the page.
````
You can write footnotes[^1] with markdown.
Scroll down to the end of the page[^2] and look for the footnotes.
## Abbreviations
````
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
````
You won't see the abbreviation directly, but if you write HTML or W3C somewhere, then you can see the tooltip with the explanation.
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
## Definition List
````
Apple
: Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
Orange
: The fruit of an evergreen tree of the genus Citrus.
````
Apple
: Pomaceous fruit of plants of the genus Malus in
@@ -61,46 +212,60 @@ the family Rosaceae.
Orange
: The fruit of an evergreen tree of the genus Citrus.
## Blockquote
There always some women and men with wise words
> But I usually don't read them, to be honest.
## Tables
Tables are a feature of Markdown Extra. Tables are not mentioned in the original Markdown specification.
````
|name |usage |
|-----------|-----------|
| My Name | For Me |
| Your Name | For You |
````
| Name | Usage |
| --------- | ------- |
| My Name | For Me |
| Your Name | For You |
## Abbreviations
This is part of Markdown Extra, too.
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
The HTML specification is maintained by the W3C.
## Code
````
Let us create some `<?php inlineCode(); ?>` and now let us check
````
Let us create some `<?php inlineCode(); ?>` and now let us check, if a codeblock works:
````
```
​```
<?php
$welcome = 'Hello World!';
echo $welcome;
?>
​```
```
## Math
Please activate the math-plugin to use mathematical expressions with LaTeX syntax. You can choose between MathJax or the newer KaTeX library. MathJax is included from a CDN, KaTeX is included in the plugin. So if you don't want to fetch code from a CDN, use KaTeX instead. The markdown syntax in TYPEMILL is the same for both libraries.
````
Use inline LaTeX ``x = \int_{0^1}^1(-b \pm \sqrt{b^2-4ac})/(2a)`` like this.
````
Use inline LaTeX ``x = \int_{0^1}^1(-b \pm \sqrt{b^2-4ac})/(2a)`` like this.
````
Or specify latex sytnax for a code-block like this:
​```latex
x = \int_{0^1}^1(-b \pm \sqrt{b^2-4ac})/(2a)
​```
````
Or specify latex sytnax for a code-block like this:
[^1]: This is the first footnote
[^2]: This is the second footnote
```latex
x = \int_{0^1}^1(-b \pm \sqrt{b^2-4ac})/(2a)
```
Please make sure that all tests run successfully.
[^1]: Thank you for scrolling.
[^2]: This is the end of the page.

BIN
content/5_info/markdown.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.1 KiB