Docs

Docs

UnMarkDocs Quickstart

From zero to docs in less than a minute

Requirements

To follow this guide, you'll need some (obvious) requirements:

  • GitHub repository with some Markdown files (the docs source)
  • GitHub account with access to that repository

If you just want to try things out, you can fork our example repository.

Creating an UnMarkDocs account

If you haven't already, go ahead and register. You'll also have to confirm your email to start creating projects.

Creating a project from a GitHub repository

Once you're logged in into your dashboard, you'll have to click the Create Project button:

Screenshot

screenshot of the button

After clicking the button, a modal will open. Click the Install the application button to access the GitHub flow.

Screenshot

screenshot of the modal

You'll be redirected to GitHub, where you'll have to select the place where your repo lives.

Screenshot

screenshot of the selector

Finally, you'll have to select connected repositories. At this point you can connect one repository, multiple ones or all the repositories under that account/organization. Of course, you'll be able to remove/add repositories at any moment following the above flow again.

Screenshot

screenshot of the page

Accessing your new documentation page

That's it! You've created your first project from a GitHub repository. There's only one simple step left: accessing it!

It's very simple. Under your dashboard, click the Go to project button.

Screenshot

screenshot of the button

You're done! sparkles