MarkdownExplorer

This Ruby Gem uses Sinatra and Redcarpet to allow you to CRUD markdown files on your local system.

Currently, only read functionality is implemented.

$ gem install markdown_explorer

Run the executable in a folder with markdown files.

$ mdexplore

Then, navigate to http://localhost:8080 in your browser

$ cd markdown_explorer
$ ./bin/setup      # install dependencies
$ rake spec        # run the test suite
$ ./bin/console    # open the interactive prompt
$ ./exe/mdexplore  # run the application
$ rake -T          # view rake commands

Other commands:

$ rake install:local  # install gem locally
$ rake release        # release to RubyGems.org (bump version.rb, first)

• Create markdown files in browser
• Edit/update markdown files in the browser
• Delete markdown files from the browser
• Create a better navigation system (tree view)

Bug reports and pull requests are welcome on GitHub at https://github.com/LaunchAcademy/markdown_explorer. Use the fork-and-branch workflow to contribute.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.