Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Readme
This project provides a minimal blogging platform based on Markdown files.
This project powers the following blogs:
$ python setup.py install
# The application will listen on port 8000 and it will
# serve the current folder
$ madblog
usage: madblog [-h] [--config CONFIG] [--host HOST] [--port PORT] [--debug] [dir]
Serve a Markdown folder as a web blog.
The folder should have the following structure:
.
-> config.yaml [recommended]
-> markdown
-> article-1.md
-> article-2.md
-> ...
-> img [recommended]
-> favicon.ico
-> icon.png
-> image-1.png
-> image-2.png
-> ...
positional arguments:
dir Base path for the blog (default: current directory)
options:
-h, --help show this help message and exit
--config CONFIG Path to a configuration file (default: config.yaml in the blog root directory)
--host HOST Bind host/address
--port PORT Bind port (default: 8000)
--debug Enable debug mode (default: False)
The application will look for a config.yaml
file in the current directory if none was
specified through the -c
command-line option. The structure is the following:
title: Blog title
description: Blog description
link: https://link.to.your.blog
# Use home_link if you have a different home/portal address
# than your blog, otherwise it's the same as `link`
home_link: https://link.to.home
# Path/URL to the logo (default: /img/icon.png)
logo: /path/or/url/here
# Blog language (for the RSS feed)
language: en-US
# Show/hide the header (default: true)
header: true
# Enable/disable the short RSS feed (default: false)
short_feed: false
categories:
- category1
- category2
- category3
Articles are Markdown files stored under markdown
. For an article to be correctly rendered,
you need to start the Markdown file with the following metadata header:
[//]: # (title: Title of the article)
[//]: # (description: Short description of the content)
[//]: # (image: /img/some-header-image.png)
[//]: # (author: Author Name <email@author.me>)
[//]: # (published: 2022-01-01)
If no markdown
folder exists in the base directory, then the base directory itself will be treated as a root for
Markdown files.
You can organize Markdown files in folders. If multiple folders are present, pages on the home will be grouped by folders.
Images are stored under img
. You can reference them in your articles through the following syntax:
![image description](/img/image.png)
You can also drop your favicon.ico
under this folder.
LaTeX support is built-in as long as you have the latex
executable installed on your server.
Syntax for inline LaTeX:
And we can therefore prove that \( c^2 = a^2 + b^2 \)
Syntax for LaTeX expression on a new line:
$$
c^2 = a^2 + b^2
$$
RSS feeds for the blog are provided under the /rss
URL.
By default, the whole HTML-rendered content of an article is returned under rss.channel.item.description
.
If you only want to include the short description of an article in the feed, use /rss?short
instead.
If you want the short feed (i.e. without the fully rendered article as a
description) to be always returned, then you can specify short_feed=true
in
your configuration.
FAQs
A minimal platform for Markdown-based blogs
We found that madblog demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.