Help:Introduction
Learn to create and edit pages
Our website, as well as out wiki are collaboratively edited by the community. They are meant as a platform to collect information about our community, Matrix, the Python programming language in general and useful information.
Report Issues
If you found an problem or you are missing a feature, please file a Bug Report or Feature Request →
Edit Workflow
Because our website is a static website, edits are done using familiar tools,
such as git, git-lfs and your favorite editor. The pages are written
in
Markdown
, a lightweight markup
language for creating formatted text.
To make a change or create a new wiki page, you need to create an issue first
and a merge request (pull request) afterwards to our
GitLab repository
.
Please check out the workflow, on how to work with the page, before making any modifications.
Image Conventions
Our convention is to use a svg image whenever possible. If this is not
possible, you use a png image, if your image contains an alpha channel. If
not use an jpeg image or an gif, if your image only references a low number
of colors. Other formats are only accepted if they are used for a special
purpose.
Section Documentation
The content/ directory is the base directory for all content.
| Section | Documents |
|---|---|
| Docs | The documentation |
| Blog | Blog posts |
| Categories | Blog categories |
| Tags | Blog Tags |
| Changelog | The “Community Changelog” page and entries |
| Contributors | Contributor personal profile pages |
| Privacy-Policy | The privacy-policy (imprint and GDPR) |
| Wiki | The Wiki |
| Wiki Categories | Wiki Categories |
| Contact | The Contact Page |
| Moderators | The Moderators Page |
| Sponsors | The Sponsors page |
The landing page itself is written in HTML and is located in
the layout/ directory as index.html. The same location is true for the
robots.txt, rss.xml, sidemap.xml and the error pages.
Shortcodes
Shortcodes are small snippets of code that are used to insert content into a page. The following shortcodes are written by us to be used to extend the capabilities of the pages, which are created as Markdown files.
| Shortcodes | Description |
|---|---|
| Accordion | Insert your content into an accordion |
| Alert | Create user defined alerts in a pager or use a preset |
| Badge | Create inline badges |
| Chart | Render Charts |
| Contributors | Display the list of contributors |
| Details | Hide content in an collapsed block |
| Dot | Display a red dot with a number in it |
| Download | Allow users to download a file |
| Figure | Place a HTML figure around your content |
| GitLab Label | Cerate a badge, which looks like a GitLab label |
| Identifier | Create an identifier pill with matrix rooms, users and email addresses |
| Img | Place a zoomable image with an optional figure |
| Ln | Create a link box, which shows a truncated lead of the page in a path |
| Moderators | Display the list of moderators |
| Post | Display an, optionally linked, post from the blog |
| Readfile | Crate a code block with source code from a file |
| Ref | Create absolute references e.g. for links |
| Relref | Create relative references e.g. for links |
| Rendered | Place a “Rendered” box around your content |
| Reporef | Create a string, which can be used as link to the repo for a local path |
| Reporting Issues | Show users how they can report Code of Conduct violations |
| Tabs | Place your content in tabs |
| Variable Structure | Create an example front matter (for documentation purpose) |
Partials
What Shortcodes are for Markdown, Partials are for HTML. They are small snippets of code that are used to insert content into a page.
Footer
| Partials | Description |
|---|---|
| footer | The footer of the page |
| script-footer | The scripts in the footer of the page |
Head
| Partials | Description |
|---|---|
| favicons | The pages favicons |
| head | The head of the page |
| opengraph | The opengraph meta tags |
| resource-hints | Resource hints such as font preloads |
| script-header | The scripts in the header of the page |
| seo | The SEO meta tags |
| structured-data | Structured data for search engines understand the content of the page |
| stylesheet | The stylesheet of the page |
| twitter_cards | Twitter Cards, you can attach rich media experiences to Tweets |
Header
| Partials | Description |
|---|---|
| alert | Alerts to show above the navbar |
| header | The header (e.g. the navbar) of the page |
Main
| Partials | Description |
|---|---|
| blog-meta | A line of information of the blog, such as the authors and publish date |
| blog-navigation | The blog’s pagination elements |
| blog-post-list-layout | |
| blog-sidebar | |
| blog-widget-archives | |
| blog-widget-categories | |
| blog-widget-tags | |
| breadcrumb | |
| date | |
| docs-navigation | |
| edit-page | |
| embedded_image | |
| fast-latex-icon | |
| last-modified | |
| wiki-category-list-layout | |
| wiki-infobox |
Sidebar
| Partials | Description |
|---|---|
| auto-collapsible-menu | |
| auto-default-menu | |
| docs-menu | |
| docs-toc | |
| internal-menu | |
| manual-collapsible-menu | |
| manual-default-menu | |
| show-rss | |
| wiki-toc |
Categories | Contributors |
|---|---|
| Help | Michael Sasser |