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 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:
- Please use
webpack
to build assets even though we use Parcel for development main
field inpackage.json
should point to amanifest.json
file generated bywebpack
plugin
note
- Not using react-router-dom because of this issue