This is a style guide for the IONOS community site tutorials. It covers general article format, Markdown usage, and other standards.
Keeping a consistent format across all articles is important. Not just for a consistent look and feel, but to help new users easily find and understand the information the article is presenting.
Write the article title as if it starts with “How to” but leave off “How to.”
Example: An article about configuring Foo on a Kubernetes cluster should be titled “Configure Foo on a Kubernetes cluster.”
All articles should start with a Table of Contents. Each item on the Table of Contents is a link to the relevant section.
To create these links, use
## for the header of each section:
## Article Structure
You can then link to this section by putting the title of the article (capitalized) in square brackets, followed by the link to the article (prefaced by a
#, all lower-case, with a dash connecting each word and no spaces).
Use two ## for the section header. Use three ### for the sub-section header.
Be sure to also list these sub-sections in the Table of Contents, in a nested UL.
Try to limit articles to a single subject. If you find an article is covering more than one subject, consider splitting it up into more articles and adding links between them.
Screenshots should be no more than 960px wide.
All images (including screenshots) should include alt and title text.
![alt text](/path/to/img.png "title text”)
All images (including screenshots) should have descriptive filenames with dashes instead of underscores.
Please do not use screenshots for code samples, configuration file snippets, and other cases where the user will have to type in the text themselves. Put this in a large code block, so that users can copy and paste it into the files.
Note: This is not intended to be a guide to Markdown code. A few good sources for Markdown syntax (including how to create UL, OL, bold, italics, and more) include:
There are two ways to indicate code: inline and indented blocks.
inline code, bracket the word or phrase with backticks (`).
In this sentence, the word `IS` will be higlighted as code.
For indented blocks of code or command line sessions, use 4 spaces (not Tab) to indent.
postgres=# \password Enter new password: Enter it again: postgres=# \q exit
What should be marked as inline code:
lsto list the directories.”
mysqlwhen you are finished.
config.phpand update the username.”
What should not be marked as inline code:
Please use the following for example data in your article, in both text and screenshots:
User name: JDoe or jdoe
First name: J
Last name: Doe
Address: 123 Main Street, Anytown, USA
URL: www.example.com or http://example.com
IP address: 192.0.2.0
Database name: mydatabase
Use “setup” when it is a noun. For example: “Edit your setup file” or “This is your setup.”
Use “set up” when it is a verb. For example: “This is how to set up your server.”
Use standard AP guidelines for capitalizing the title of the article. Capitalize all of the nouns and verbs, but do not capitalize the small connectors.
In other words, capitalize every word with more than 3 letters. Capitalize 1-3 letter words only as necessary.
Words that are NOT capitalized, unless they are the first word of the title: a, an, and, at, but, by, for, in, of, on, or, the, to, and up.
Section and sub-section titles
Inside the article itself, use “sentence case” for article section titles, and sub-section titles.
Write titles as a command (imperative tense). Do not use the gerund (-ing) form of the verb.
If it helps, imagine that each title begins with “How to” or “Next you must.”