@okmarvin/january

Adds this package to your okmarvin project and configures _config.toml to use it:

Usage no npm install needed!

<script type="module">
  import okmarvinJanuary from 'https://cdn.skypack.dev/@okmarvin/january';
</script>

README

Usage

Adds this package to your okmarvin project and configures _config.toml to use it:

theme = "@okmarvin/january"

Make sure to put logo image into okmarvin project/public/static/img folder.

Available Options for _config.toml

Option Description
github github username
twitter twitter username
google_analytics Google Analytics ID
source Where you host your markdown source files

Develop

Clone this repo and install dependencies:

$ git clone https://github.com/OkMarvin/january.git
$ cd january
$ npm install

Run npm start to start development server.

Build for production

Just run npm run build.

But there are some requirements when you build theme for okmarvin:

  1. Please use webpack to build assets even though we use Parcel for development
  2. main field in package.json should point to a manifest.json file generated by webpack plugin

note

  1. Not using react-router-dom because of this issue