markdown-only

HERE you can check the site of this repo.

This is a template repository to help you build sites with markdown files only and present them with GitHub styles on GitHub pages.

To use this template:

1. Just start to GENERATE it. (Notice: you can also use it on the repository page on GitHub.)
2. Deploy the GitHub page inside the setting of your new repository.
3. Feel free to write your first markdown file: README.md.

Examples

Variables

Current supported configure variables of this theme:

• color-mode: specify the light / dark mode you intent to use. (dark by default)
• theme-color: specify the theme color meta. (#1e2327 by default)

FAQ

As we use jekyll to build sites, it should use Rouge to highlight syntax of code snippets and it is different from the highlighter of GitHub. It means that there should be various highlights of the same code like the following:

const data = function () { 
    // ...
    return {
        'markdown-only': { key: 'value'},
    };
};

To try to eliminate the differences, I will update the adapter according to some situations.

How to contribute

Have an idea? Found a bug? See how to contribute.

License

MIT © aleen42