The framework we use for docs.
Branch: master
Clone or download
Latest commit 376001e Nov 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
layout Use new nav Nov 8, 2018
source Use new nav Nov 8, 2018
tests Force color output from shelljs, particularly for `npm` commands. Aug 23, 2018
.gitignore Update gitignore for Node.js projects. Feb 13, 2018
.npmignore Implement a test theme suitable for running Netlify test deploys. Feb 13, 2018
.nvmrc Add a .nvmrc for Netlify. Feb 13, 2018
CHANGELOG.md
LICENSE Create LICENSE Oct 4, 2018
README.md Update README.md May 17, 2018
_config.yml Only inject docsearch JavaScript when docsearch is enabled. Mar 16, 2018
circle.yml Add a circle.yml so we can run under Node.js 8. Feb 21, 2018
npm-shrinkwrap.json 2.0.1 Nov 8, 2018
package.json

README.md

Usage

The theme is available on npm as meteor-theme-hexo. The theme can be used by either:

  1. (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
  2. (less ideal) Cloning this repository into the doc deployment's themes/meteor directory and referring to the theme in that deployment's _config.yml as just meteor. This will require you to update the theme (or at least its submodule) manually!

Developing

In order to develop this theme, you should:

  1. Check out this (meteor-theme-hexo) repository.

  2. Check out the theme-example docs deployment alongside the meteor-theme-hexo directory.

  3. Check out either (apollo-hexo-config or meteor-hexo-config) alongside the meteor-theme-hexo directory. This will leave you with something like:

    Dev/
    ├── meteor-theme-hexo/
    ├── meteor-hexo-config/ (or apollo-hexo-config/)
    └── theme-example/
    
  4. Run npm install in the meteor-theme-hexo

  5. Switch to the theme-example directory.

  6. Run npm install

  7. 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 🚀
☺️ meteor/guide https://guide.meteor.com/
☺️ meteor/docs https://docs.meteor.com/
☺️ meteor/galaxy-docs https://galaxy-guide.meteor.com/
☺️ apollographql/apollo https://www.apollographql.com/docs/
☺️ apollographql/apollo-client https://www.apollographql.com/docs/react/
☺️ apollographql/apollo-link https://www.apollographql.com/docs/link/
☺️ apollographql/apollo-angular https://www.apollographql.com/docs/angular/
☺️ apollographql/apollo-ios https://www.apollographql.com/docs/ios/
☺️ apollographql/apollo-android https://www.apollographql.com/docs/android/
☺️ apollographql/docs-docs https://docs-docs.netlify.com/docs/docs/
☺️ apollographql/graphql-tools https://apollographql.com/docs/graphql-tools/
☺️ apollographql/apollo-server https://apollographql.com/docs/apollo-server/
☺️ apollographql/subscriptions-transport-ws https://www.apollographql.com/docs/graphql-subscriptions/
☺️ apollographql/engine-docs https://www.apollographql.com/docs/engine/
☺️ apollographql/community https://www.apollographql.com/docs/community/

[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.