a guide to doc depot

DocDepot is a very simple solution to upload your markdown files

In just a few steps, you can make your knowledge available to the whole world via Markdown and DocDepot.

If you don't know what markdown is or how to use it, check out this guide

Step 1. Go to the upload page

Go to DocDepot's upload page at: https://docdepot.vercel.app/upload

Step 2. Paste your markdown

From here, the page will show you the step by step on how to upload your file.

You will see two main boxes towards the top of the page. Paste your markdown into the box on the left and it will show you a preview in the box in the right. This is example how it will look like when it's uploaded.

Step 3. Name your document

The next input box will ask you for a name for your document. This is the name by which people can access your document.

If you name your document guide, it will be found under the following URL: https://docdepot.vercel.app/view/guide.

If you are not logged in: It is advised that you prefix your documents with a username so that we can help you locate them if you haven't written them down.

DISCLAIMER: Anyone who has the name will be able to view your document, but I am working on features which will allow you to restrict viewership.

Step 4. Protect your document

On the home page I state that you don't need to login in order to publish your markdown. This is true but also not very secure so, if you are not logged in, you need to provide a password.

This will be used if you want to edit/remove your document and when you want to add the document to your account. Once you add the document to your account, you can edit/remove it without having to enter the password.

Step 5. Upload your document

There will be a button at the bottom of the page which you should press. Your document is now published.

As mentioned earlier, it will be found at https://docdepot.vercel.app/view/{name} , and it will give you the URL when you upload.

And that's it. This is supposed to be a very simple tool at this point, and will stay this way for a while.

Future of DocDepot

That being said, I have loads of ideas for features that I want to implement in the near future, such as:

  • More advanced markdown editor (syntax highlighting, keyboard shortcuts, spellcheck)
  • Restricted viewership (people need a password to view your document)
  • Document analytics (views, link clicks, live viewer count, referrer)
  • LaTeX syntax
  • Document groups (for things like blogs and documentation)
  • Version control (view history of the document and revert changes)
  • Extra markdown syntax (underline, strike through, highlight, check list, table and more)
  • And more..

When I start to work on these features, I will select a few for you to vote for which one I should work on next. That way, I'm only working on what people want the most.

If you have any features you want me to add or bugs you want me to fix, don't hesitate to reach out on twitter or open an issue on github.

Contact Me

You can contact me on twitter: @oscarfalll or github: thereal-atom, and I may or may not be working on a discord server for this project too.

Last updated: 14th October, 2023 ~ 13:30 GMT