@meteorjs/meteor-theme-hexo
v2.0.8
Published
[Read the docs docs.](https://docs-docs.netlify.com/docs/docs/)
Downloads
319
Keywords
Readme
Usage
The theme is available on npm as meteor-theme-hexo
. The theme can be used by either:
- (preferred) Installing the theme from npm and allowing dependency auto-update tools, like @renovate-bot or @greenkeeperio-bot, to update the npm for you. This requires you to set the
theme
in your_config.yml
as../node_modules/meteor-theme-hexo
; or - (less ideal) Cloning this repository into the doc deployment's
themes/meteor
directory and referring to thetheme
in that deployment's_config.yml
as justmeteor
. This will require you to update the theme (or at least its submodule) manually!
Developing
In order to develop this theme, you should:
Check out this (
meteor-theme-hexo
) repository.Check out the
theme-example
docs deployment alongside themeteor-theme-hexo
directory.Check out either (
apollo-hexo-config
ormeteor-hexo-config
) alongside themeteor-theme-hexo
directory. This will leave you with something like:Dev/ ├── meteor-theme-hexo/ ├── meteor-hexo-config/ (or apollo-hexo-config/) └── theme-example/
Run
npm install
in themeteor-theme-hexo
Switch to the
theme-example
directory.Run
npm install
Inside
theme-example
, run:npm start -- --config-dir ../apollo-hexo-config --theme-dir ../meteor-theme-hexo
(or
meteor-hexo-config
, if working on the Meteor theme!)
For more information, check the README.md on
theme-example
.
Docs docs
There are docs docs for help with docs deployments! Please read them (and help update them on their own repository if they're wrong!).
Known deployments
Important: Please submit a PR to update this list when making new deployments to ensure they receive important PRs (such as dependency and repo consistency updates).
| [0] | GitHub Repo :octocat: | Deployment URL :rocket: | | --- | --- | --- | | :relaxed: | meteor/guide | https://guide.meteor.com/ | | :relaxed: | meteor/docs | https://docs.meteor.com/ | | :relaxed: | meteor/galaxy-docs | https://galaxy-guide.meteor.com/ |
[0] Equipped with auto-update dependency management, so you don't need to make sure the theme is updated.
If a change to this theme is made, it should be re-published to npm. Those repos using submodules should update their submodule reference to the latest tip and those using the meteor-theme-hexo
npm package should update that dependency to the latest published version.