https://github.com/zoomten/mdiocre

A (terrible) generator for static websites from Markdown (and other markup) files.
https://github.com/zoomten/mdiocre

Last synced: about 6 hours ago
JSON representation

A (terrible) generator for static websites from Markdown (and other markup) files.

• Host: GitHub
• URL: https://github.com/zoomten/mdiocre
• Owner: ZoomTen
• License: mit
• Created: 2019-03-06T09:31:06.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-02T10:32:27.000Z (over 1 year ago)
• Last Synced: 2023-07-02T11:24:46.776Z (over 1 year ago)
• Language: Python
• Homepage: https://zumi.neocities.org/stuff/mdiocre
• Size: 175 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MDiocre

![MDiocre](logo.svg)

A very simple static website generator tool powered by Python. It primarily converts Markdown files and combines it with an HTML template, but can be extended to other markup.

## Requirements

* Python 3 (`python-markdown` + `py-gfm`)

## Other Requirements

**ReStructuredText** (RST) support requires `docutils` to be installed.

If you want to build the **documentation**, you will have to install Sphinx as well.

## What sets it apart from other tools?

It's terrible and it doesn't have a profitable and pragmatic usecase in mind, but it works okay. For my needs, anyway. It's alright for simple blogs with no tagging and very simple static websites.

## How do I make a site with this?

1. Install `mdiocre` by using the command: `python3 -m pip install mdiocre`.

2. Create a work folder. Let's call it `work`.

3. Make a file called `template.html` inside that folder with these contents:

   

   ```

   

   Welcome to my website!

   

   

   ```

4. Create a folder called `src`, and make a file inside of it called `index.md`, and write anything on it.

5. After your content (or before, it doesn't matter), add: ``

6. Go back a level to your `work` folder. Assuming Python is present in your PATH (environment variable), create a new text document containing:

   

   ```

   python3 -m mdiocre.interface.cli src build

   ```

   

   Save it inside the folder as a .bat if you're on Windows, or as a .sh if you're on Mac, Linux, or other Unix-like systems. Double click or execute it.

7. Check the `build` folder.

## Variables

MDiocre allows setting variables. These variables are per-page, and can be read by the template. Both the template and the markdown page share the same format for templates - which are HTML comments with the first character after the markup being the colon (:)

**Setting a variable to a string**

```

```

Simply sets `hello` to `test message`. When using a comma, make sure to escape it with \\!

**Setting a variable to another variable**

```

```

If `lemons` is `1` then `hello` will also be `1`. If `lemons` is not set, `hello` will contain the string `lemons`.

**Concatenating two or more variables**

```

```

If `hello` contains `abc` then `lemons` will contain `abcabc`. However, if you also include a space string in between, like this...

```

```

`lemons` will contain `abc abc`!