Yamado

Yamado is a note & journal system with extensions for functioning as a website. The file system is used to store all data and the system is mostly text-driven. All articles are submitted as files in the Yamado format, which is YAML + Markdown.

Features

Core:

• A command interface for controlling a repository of articles.
• Text file based repository; no database needed.
• Meta data for articles: authors, topics, series, keywords, abstract.
• Text driven control of article properties using categories.
• Hooks for extending core functionality.

Requiring a markdown processor:

• Conversion to HTML website.
• Atom feed generation.

More converters planned to come.

Other resources

• Installation guidance.
• Yamado man page.
• Contributing.

Community:

• List of websites that use Yamado.
• Mailing list
• Reddit/yamado

Packages:

• Arch Linux package

Use

Yamado is an interface to a system of scripts and programs. The normal command format is yamado <subcommand>. Try yamado help.

The simplest way to write an article is with:

yamado write -i

Which will ask you some questions and then launch an editor. Once saved and closed, the article is added in the repository.

To run the publishing hooks (e.g. the HTML converter), run:

yamado publish

To further customise and extend Yamado, look into hooks/.

YMD Format

A .ymd file has two segments, the YAML header and the Markdown body. Calling yamado form prints an empty template header and space for the markdown.

Take a look at the empty template of a ymd header, the fields are quite self-explanatory.

For more information look at the yamado man page.

Package

The files in this directory constitute the Yamado system.

• yamado: Service functions
• yamadoclient: A client to control remote installations via SSH.
• yamadoctl: Service control for owners or administrators.
• bin/: Directory of scripts used by Yamado. You shouldn't call these directly unless you know what you are doing.
• share/: Resources shared by other services.
• converters/: Collection of converter scripts.

Yamado client

Install the yamadoclient script on your local system and configure $HOME/.config/yamado/client.conf. Checkout the example client.conf in share/.

The available commands are:

• copykey: installs your local ssh public key on the server.
• ls: lists all added articles.
• form: returns any empty template from the server.
• write: opens an editor with on empty template and uploads it when editor exits.
• add: add a local file and its attachments to the server.
• get: get an article from the server and return the temporary directory.
• edit: gets a file and launches the default editor; uploads & adds the article once editor is closed.
• publish: run publish on the server.

Licence

AGPL 3.0: http://www.gnu.org/licenses/agpl-3.0.txt

All files are distributed provided by Yamado are licenced under AGPL 3.0. A brief of the licence is at the bottom of this file and a full copy in LICENCE. Some files are without notice, list at the end of this file.

AGPL brief

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Files without notice

The following files don't contain a licence notice but are still under AGPL 3.

• share/ymd.template
• share/yamado.conf
• share/header.md
• share/footer.md
• share/hooks/