diff --git a/README.md b/README.md new file mode 100644 index 0000000..4ac00ae --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +Obsidian: A Plugin for Pelican +============================ + + + +Obsidian is a pelican plugin that allows you to use the syntax used within Obsidian and when pelican then renders these posts it won't look weird or out of place. + +Phrased differently, if you don't like that `#` is included in the name of the tag when you name it `#my-tag` and you think that internal pelican links are difficult to remember and would like to use `[[ my link ]]` as an internal link instead this plugin would be for you. + + +Installation +------------ + +This plugin can be installed via: + + # not yet on pypi, but when it is you can install it with. + pip install pelican-obsidian + +Usage +----- +Install the plugin as described in the pelican documentation. + +In the tags section you will be able to use `#` without that being reflected in the actual name of the tag. In other words. + +``` +Tags: #my-tag + +# reflects as +my-tag in the html output. +``` + +The backlinks in Obsidian follows this format `[[ document | Actual link name ]]` The actual link name is optional. + +To specify the location of an attachment the following syntax is used `![[ filename.jpg ]]`. They explain more about the syntax in the section on [how to embed files](https://help.obsidian.md/How+to/Embed+files) + + +Future features +--------------- + +- Embed files or sections as described [here](https://help.obsidian.md/How+to/Format+your+notes) +- Task list? + + + + +License +------- + +This project is licensed under the AGPL 3.0 license.