Skip to content

md2site Documentation

David Seek edited this page Jan 11, 2022 · 23 revisions

Welcome

This is the documentation for md2site.com. Here you can find information on how to create a static website with md2site. We're going to continuously add new sections based on frequently asked questions.

General

What is md2site?

md2site is a markdown to static website generator. You define the content in markdown, select a template, and the generator creates a website from your markdown and hosts it for you. You can then either use the .md2site.com url or link your own domain. Screenshot of the v1 Side-by-Side editor

What is Markdown?

markdownguide.org

How to get started

Getting started with md2site is as simple as 1-2-3.

  1. Create a user account
  2. Create a new project
  3. Write your content and press save. Your changes are now deployed to production.

How to add Sub Pages

Every project contains a Main Page, the Main Page is hosted under index.html. To create a new one, click + Add Sub Page. The name you enter will become the URL. If you name your Sub Page Foo Bar, then the file will be hosted under /foo-bar.html.

On your Main Page, you can then create a link to your Sub Page:

## This is my Main Page
- [Click here for Foo Bar](https://my-domain.com/foo-bar.html)

And to navigate back to the Main Page, just add a back button to the top of the Sub Page, that links back to your parent domain:

## This is Foo Bar
- [Back](https://my-domain.com)

How to link to a specific Anchor on a Sub Page

You can jump to a desired part of your page by using an Anchor tag. In the Text editor, just add (anywhere in your Markdown text):

<div id="readmore><div>

Screenshot of Anchor Text That will create an invisible Anchor tag, that you can use like so: domain.com/sub#readmore

How to customize the Style of a template

md2site offers JavaScript injection for all Premium projects.

  1. Open the desired project
  2. Press the Settings button (corg)
  3. In the Premium section, find and select Edit Script
  4. Add whatever styling you would like to override. Reach out if you need help.

Example: How to customize background and text color

To update the background and text color, paste the follow script snipped into the textfield:

<style>
* {
    color: #121211 !important;
    background: white !important;
}
@media (prefers-color-scheme: dark) {
  * {
    color: white !important;
    background: #121211 !important;
  }
}
</style>

This code snipped adds a style tag. In there we're setting all text colors (color), of all website elements (*) to the color hex of #121211. And the background color to white. For dark mode we're reversing setting the opposite. The result will be a dark gray text on white in light mode, and a dark gray background with light text in dark mode.

Code Injection Modal

To set the background and text color to the same values in dark and light mode, you'd set the style to something like this:

<style>
* {
    color: white !important;
    background: #121211 !important;
}
@media (prefers-color-scheme: dark) {
  * {
    color: white !important;
    background: #121211 !important;
  }
}
</style>

Now the background is dark gray in light and dark mode, and the text color white in both modes.

You can use pages like coolor.co to find a color's hex code you like.

How to link your own domain

md2site offers DNS access to all Premium projects.

  1. Open the desired project
  2. Press the Settings button (corg)
  3. In the Premium section, find and select Edit DNS Status
  4. Follow the On-screen instructions. It's important, that you add all DNS parameters as described. If you don't know how, create a help request (Issue), and we'll help you and create a tutorial for your specific domain provider.

My SSH isn't working

This might be a propagation issue. Most provider take up to 24 hours to load and store the proper DNS values. Just wait a bit, md2site will automatically retry to set the SSL certificate.

Pricing

What's the pricing?

A subscription for a static website is priced at $9.99 per year. You can create as many websites as you like within a single user account. Each website requires a subscription.

How do I cancel my subscription?

You can cancel your subscription at any time at the Settings of your website. Open the website, click the Corg Button and click Cancel Subscription. The subscription will expire at the end of your billing period. You'll continue to have full access to all services until then. The page will link back to md2site.com afterwards.