https://github.com/pegasd/md2conf
Convert Markdown to XHTML ready to be posted to Confluence
https://github.com/pegasd/md2conf
Last synced: over 1 year ago
JSON representation
Convert Markdown to XHTML ready to be posted to Confluence
- Host: GitHub
- URL: https://github.com/pegasd/md2conf
- Owner: pegasd
- License: mit
- Created: 2017-07-12T17:56:06.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-12-04T13:36:50.000Z (over 6 years ago)
- Last Synced: 2025-02-26T20:37:51.735Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 39.1 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Md2conf
Converts Markdown to Confluence storage format
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'md2conf'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install md2conf
```
## Usage
### Basic usage
```ruby
require 'md2conf'
conf_xhtml = Md2conf.parse_markdown(File.read('./README.md'))
```
Contents of `conf_xhtml` is now ready to be pushed to Confluence.
### Custom macros
It is possible to set up custom macros to be processed inside your Markdown files.
Macros must be specified in the format `{MACRO_NAME:MACRO_ARG}` and reside outside of code blocks.
Macro definition are read from the file `~/.md2conf.yaml` inside a `macros` key:
```yaml
macros:
PUP: 
PUPTEXT: PUP-%s
```
Having these definitions, the following macros:
```markdown
{PUP:7123} Fixed a bug
{PUPTEXT:7885} Work in progress
```
will be converted to this:
```html
Fixed a bug
PUP-7885 Work in progress
```
Note the usage of `%s` - these will be replaced by the `MACRO_ARG` part that is specified inside each macro.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports, feature and pull requests are welcome at the official GitHub [repo](https://github.com/pegasd/md2conf).