Giter VIP home page Giter VIP logo

camunda-docs-theme's Introduction

Camunda theme for Hugo docs

Install

Clone this repository/branch aside of the camunda-docs-manual:

# from the camunda-docs-manual directory
cd ..
git clone [email protected]:camunda/camunda-docs-theme.git
# go into its directory
cd camunda-docs-theme
npm i
npm run build

Note: you can clone this repository anywhere, but you may then change the setup.target value of package.json.

Working

After installing (you probably want to have hugo running as watching server) and then run npm run build from this directory.

Consuming the theme

  1. Edit the setup.target value of package.json to point to the theme's root directory in your Hugo project (default: ../camunda-docs-manual/themes/camunda).
  2. Build and update the theme in the target location by either running:
    1. grunt build for building and syncing non-minified assets
    2. Run additionally grunt optimize for building and syncing minified assets

Using git subtree

You can also consume the theme in a project via git subtree:

Adding the latest version of the theme as camunda:

git subtree add -P themes/camunda [email protected]:camunda/camunda-docs-theme.git dist --squash

Updating the theme to the latest version:

git subtree pull -P themes/camunda [email protected]:camunda/camunda-docs-theme.git dist --squash

Theme development with Virtualbox

This would be the command to execute in order to make the local development site of camunda-docs-manual (see --baseUrl option) available in a virtualbox (typically for IE). Livereload should be deactivate (see --disableLiveReload) if you want to develop for IE9.

hugo --bind="0.0.0.0" --baseUrl="http://10.0.2.2:1313/manual/develop/" -w --disableLiveReload=true server

The development site is then available on http://10.0.2.2:1313/manual/develop/ in your virtualbox guest OS.

Licence

MIT

camunda-docs-theme's People

Contributors

akeller avatar christinaausley avatar cmur2 avatar csuermann avatar danielkelemen avatar felix-mueller avatar hawky-4s- avatar jedidrew42 avatar jpguisa avatar koevskinikola avatar lwille avatar manueldittmar avatar marstamm avatar mary-grace avatar mboskamp avatar menski avatar meyerdan avatar mschoe avatar pepopowitz avatar romansmirnov avatar siffogh avatar tasso94 avatar thorbenlindhauer avatar tmetzke avatar zeropaper avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

camunda-docs-theme's Issues

Uniform styling for links

On hover: Body a tags have underline and dark blue color. While sidebar link is just getting black. Having uniform styling would be better.
Examples-docs-camunda-org

Search box is hidden on smaller screens

At 800px of screen width, the Search box disappears from the top navigation. This makes it impossible to search on smaller (or even medium sized) devices.

Here's a video of resizing a window. Note the disappearance of the Search box about halfway through:

Screen.Recording.2023-10-19.at.10.57.29.AM.mov

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.