Skip to content

Latest commit

 

History

History
226 lines (173 loc) · 7.22 KB

README.md

File metadata and controls

226 lines (173 loc) · 7.22 KB
Raw

mate-desktop.org

This repository contains the Nikola configuration and content for http://mate-desktop.org.

Contributing content

If you want to add or edit content on http://mate-desktop.org, please submit a pull request.

Contributing a new post

Contributing a new blog post to the mate-desktop.org website is simple.

  • Fork this repository.

  • Copy blog/20991231markdown-template.md to a new file. For example:

    cp blog/20991231template-markdown.md blog/20131107my-cool-blog-post.md

  • Edit your new file, making sure to change the metadata in the file header. The following are valid metadata fields and what they're for.

    • link is optional, but should include the URL to the original article if there is one.
    • description is optional, and should briefly describe the post.
    • tags are any tags that are relevant. You must include the draft tag.
    • date is the intended publication date of the post in the format YYYY/MM/DD HH:MML:SS
    • title is the post title
    • slug is how the post name will be represented in the URL. Make sure you modify the date prefix.
    • author is your full name.

  • Commit your changes, submit a pull request and one of the website maintainers will review your submission and publish it if it is suitable.

If you prefer ReStructuredText to Markdown, then follow the same process as above, but use blog/20991231rest-template.rst as the template file.

Embedding images

Markdown and reStructured Test both have markup for embedding images. To embed an image, just drop your correctly sized image into the files/assets/img/blog/ directory and then link to it. When linking to an image assets you drop the 'files prefix from the Markdown and reStructured Text markup.

Markdown image example

![MATE](/assets/mate-128.png)

reStructured Text image example

.. image:: /assets/mate-128.png
    :align: center

Submitting posts for future publication

The date field in the metadata also controls when a post will be published. If you have created a post that should be published at a specific date or time, set the date/time accordingly and that post will not be published until that time.

The mate-desktop.org website is redeployed every 10 minutes, so the actual publication time will be accurate to the nearest 10 minutes.

Preventing a post from being published

If you have a post you are working on but do not wish to publish, just add draft to the list of tags in the metadata. Posts tagged as draft will not be published.

Contributing a translation

To contribute a translated page or blog post to the mate-desktop.org website do the following:

  • Fork this repository.

  • Copy the blog post or page you wish to translate to a new file with the same filename but ending with the short country code (see below). For example, if you want to translate the home page to German you would do the following:

    cp pages/index.md pages/index.de.md

  • Translate the metadata as well as the content. However, do not change the date format.

  • Commit your changes, submit a pull request and one of the website maintainers will review your submission.

Nikola supported languages are, the one in bold are already in the site navigation::

  • ar Arabic
  • az Azerbaijani
  • bg Bulgarian
  • bs Bosnian
  • ca Catalan
  • cs Czech [ALTERNATIVELY cz]
  • da Danish
  • de German
  • el Greek [NOT gr]
  • en English
  • eo Esperanto
  • es Spanish
  • et Estonian
  • eu Basque
  • fa Persian
  • fi Finnish
  • fr French
  • gl Galician
  • he Hebrew
  • hi Hindi
  • hr Croatian
  • hu Hungarian
  • id Indonesian
  • it Italian
  • ja Japanese [NOT jp]
  • ko Korean
  • lt Lithuanian
  • ml Malayalam
  • nb Norwegian (Bokmål)
  • nl Dutch
  • pa Punjabi
  • pl Polish
  • pt Portuguese
  • pt_br Portuguese (Brazil)
  • ru Russian
  • sk Slovak
  • sl Slovene
  • sq Albanian
  • sr Serbian (Cyrillic)
  • sr_latin Serbian (Latin)
  • sv Swedish
  • te Telugu
  • th Thai
  • tr Turkish [NOT tr_TR]
  • uk Ukrainian
  • ur Urdu
  • vi Vietnamese
  • zh_cn Chinese (Simplified)
  • zh_tw Chinese (Traditional)

Markdown vs. ReStructured Text

mate-desktop.org converts Markdown or reStructured Text into HTML. In general we recommend Markdown, but some of the Nikola advanced features are only exposed via reStructured Text extension.

Markdown

Nikola follows the syntax rules of the original markdown.pl with the following extensions enabled:

  • extra
  • codehilite
  • toc

reStructured Text

See the Nikola reStructuredText Primer and the reStructured Text extensions.

Creating a Nikola stack

For the MATE Desktop core team, if you need to create a Nikola stack for testing/deployment the installation process is documentation for Ubuntu (also works in Debian Jessie) here:

Fedora, Debian, Ubuntu

STEP 1: Install the following packages on your system

On Ubuntu/Debian:

sudo apt-get install python3 python3-pip asciidoctor virtualenv

On Fedora:

sudo dnf install python3 python3-pip asciidoctor virtualenv

STEP 2: Create a new virtualenv named nikola in ~/MyVirtualEnvs folder

mkdir -p ~/MyVirtualEnvs
cd ~/MyVirtualEnvs
virtualenv -p $(which python3) nikola

STEP 3: Activate the virtualenv created in STEP 2

source nikola/bin/activate

STEP 4: Install the following python packages in the virtualenv

(nikola) pip install --upgrade pip
(nikola) pip install --upgrade "Nikola[extras]"
(nikola) pip install --upgrade python-Levenshtein
(nikola) pip install --upgrade pathlib
(nikola) pip install --upgrade beautifulsoup4

(nikola) is part of your shell prompt for the virtualenv named nikola, not part of the command.

STEP 5: Build and test the web site

(nikola) cd ~/mate-desktop.org
(nikola) nikola build -c
(nikola) nikola serve

STEP 6: Open the site in a web browser

Open the URI displayed in the previous step using your favorite web browser.

STEP 7: Exit virtualenv

Press ^C to close nikola serve

(nikola) deactivate

TODO