Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 1.88 KB

README.md

File metadata and controls

67 lines (42 loc) · 1.88 KB
Raw

githubmd

About

A GitHub Flavored Markdown (GFM) editor built, accessible anywhere and anytime.

GFM is the dialect of Markdown that is currently supported for user content on GitHub.com and the GitHub Enterprise. You can read more about GFM on their official Markdown Spec.

Need to create a README for your GitHub project? Or need to edit a basic markdown file? githubmd offers a fast and simple solution.

Stack

NodeJS Docker

Setup

The following are the steps on running the server locally.

Clone the repository.

git clone https://github.com/gmlunesa/githubmd.git

Install Node modules.

npm install

Run the application.

npm start

If you wish to build and run a Docker image, please follow the following steps.

Build an image upon which your container will be built.

docker build -t sample-container:dev .

Run container.

$ docker run -it --rm \
  -v ${PWD}:/app \
  -v /app/node_modules \
  -p 3001:3000 \
  -e CHOKIDAR_USEPOLLING=true \
  sample-container:dev

License

MIT 🌱 Fully open-source

Credits

  • Favicon is from the open source project Twemoji.

Made with 💫✨ by gmlunesa