Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken headings in Markdown files #17

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##About Actuarius##
## About Actuarius ##
Actuarius is a Markdown Processor written in Scala using parser combinators.

The project homepage can be found on github: https://github.com/chenkelmann/actuarius
Expand All @@ -12,20 +12,20 @@ To try Actuarius out, you can use the web dingus on my home page: http://henkelm

To get Actuarius, you can either check out the source from github, use maven/sbt to add it as a dependency (see below) or download the binary jar, javadoc jar or source jar directly from my maven repo at http://maven.henkelmann.eu/eu/henkelmann/

##License##
## License ##
Actuarius is licensed under the 3-clause BSD license. For details see the `LICENSE` file that comes with the source.

##Compatibility##
## Compatibility ##
Actuarius tries to stay as close to the original Markdown syntax definition as possible. There were however some quirks in the original Markdown I did not like. I wrote Actuarius as a Markdown processor for my homebrew blog engine, so I took the liberty to diverge slightly from the way the original Markdown works. The details are explained [in the respective article in the Actuarius Wiki](https://github.com/chenkelmann/actuarius/wiki/Differences-Between-Actuarius-And-Standard-Markdown)

##Maven##
## Maven ##
The group id is `eu.henkelmann`, the artifact id is `actuarius_[scala-version]`, e.g.`actuarius_2.10.0`. The current stable version is 0.2.6. The current development version is 0.2.7-SNAPSHOT.
Actuarius is available from the [Sonatype OSS repository](https://oss.sonatype.org), so you should not have to add any repository definitions.

Starting with version 0.2.5 there are builds for Scala 2.9.2 and 2.10.0. These versions are also available from maven central.
(How I hate Scala's binary incompatibilities…)

##sbt##
## sbt ##
To add the lib to your project, add the following to your `.sbt` file if you are using scala 2.10.x:

libraryDependencies += "eu.henkelmann" % "actuarius_2.10.0" % "0.2.6"
Expand All @@ -37,7 +37,7 @@ or, for 2.9.x compatibility:

Currently, Actuarius itself is built using sbt 0.11.x

##Version History##
## Version History ##

### 0.2.6
* fixed bug in html / xml element parsing: attributes surrounded by ticks (`'`) are now also parsed as well as attributes surrounded by quotes (`"`)
Expand Down