shubham-sharma-2323 / markdownpedia

A site similar to Wikipedia written in Markdown.

Markdownpedia

Markdownpedia is a site similar to Wikipedia. All you got to do to edit a page is go to site/markdown and edit/add a page.

This site was made for contributions. You can make an article on anything (Under R). This site is to be shaped by the community, you guys.

Then you create a pull request, and bam. You're done. Once a moderator (need some) approves of it, it'll be added to the site.

You can go to https://status.markdownpedia.tk/ to check the status of the site.

Running locally

You can open it with Gitpod.io or Repl.it and it'll run on those sites just fine.

I don't know if it's a good idea, because these might get big. Editing a page can be done on github, and soon with an editor.

First clone the repository.

git clone https://github.com/mamamia5x/markdownpedia

Then cd into markdownpedia

cd markdownpedia

Then install everything

npm install

Now everything should be set up.

To start the server and view all the pages, run

npm run serve

To convert markdown files to html files run

npm run convert

---

Adding Pages to the Site

1. Go to markdownpedia's repository and fork it.

2. Go to your forked repository.

3. In your forked repository, go to the site folder.

4. Then go to the markdown folder.

5. Here press Add file.

6. Press Create new file

7. At the Name of your file, type in the name of the article. Then type /index.md

8. Add a new tab and go to the editor and type in the files content.

9. Copy the text and paste in the other GitHub tab.

10. Press Propose new file and then press Create Pull Request.

11. Your file will be reviewed and then added if there is no issue.

---

Useful resources:

• How to fork a repository

• How to create a pull request