readme.gen

Recreating readme.so completely in Vue!

An online markdown editor to create README files.

This website was build only for practice purpose.

Cloned webapp: readme.gen

Original webapp: readme.so

Table of contents

• Features
• Screenshots
• Built with
• Setup and installation
• Inspiration
• License

Features

• Light/dark mode toggle
• Live preview of your markdown content
• Choose from a list of sections to add to your readme
• Add a code/link/table from quick template tool
• Edit the contents of each section
• Change order of sections
• Copy your readme content to your clipboard
• Download content to local machine

Screenshots

Readme-gen markdown editor page:

Built with

• Vite
• Vue.js
• Typescript
• Pinia
• Docker
• Makefile

Vue libraries

• marked

Setup and installation

Clone the repository

git clone https://github.com/ksaswin/Readme-gen.git
cd Readme-gen

Install dependencies

make env

Compiles and hot-reloads for development

make host-ui

Then, navigate to locahost:5173, or http://ip_address:5173.

Run using docker:

make host-docker-ui

Now, the dev server will be hosted on your machine's IP address. You can view this from http://ip_address:5173.

Lint checks:

make lint

Formatting the code:

make format

Build command:

make build

Remove node_modules/, dist/ and perform clean-up:

make distclean

Clean up docker images created for the project:

make clean

Customize configuration

See Configuration Reference.

Inspiration

As mentioned in the introduction, this project is based on an existing app created by Katherine Peterson.

I used readme.so to create README files for all my projects. After I learnt the basics of VueJs, I thought this could be the perfect project to recreate/clone, since I personally enjoy using it so much.

License

MIT

This readme was created using readme.gen ;)