Git Product home page Git Product logo

mostlydocs's Introduction

Docsy "mostly docs"

This is an example site that uses the Docsy Hugo theme. It's an alternative version of the "just the docs" site that uses a documentation page as its home page, which each section also being documentation, rather than starting from /docs/.

You can see a preview of this site at https://mostlydocs.netlify.app/

This version does not require a modified copy of the Docsy theme's layouts, so is easier to keep in sync with the Docsy theme. It does this by making use of the target-specific front matter cascade feature that was introduced in Hugo 0.76.0 (with a bug fixed in 0.77.0 that's required for this to work).

If you take a look at content/en/_index.md, you'll see:

cascade:
- _target:
    path: "/blog/**"
  type: "blog"
  # set to false to include a blog section in the section nav along with docs
  toc_root: true
- _target:
    path: "/**"
    kind: "page"
  type: "docs"
- _target:
    path: "/**"
    kind: "section"
  type: "docs"

This makes every page in the site default to the docs type, except for /blog/* (you could leave this out, of course, or add other sections that you don't want to be treated as docs).

The toc_root setting causes the blog section to be removed from the main section menu in the left bar, and instead show up only when Blog is selected from the top menu, making it appear completely separate.

Otherwise it all works just like any other Docsy site.

To use this for yourself, make a copy of this template project and change content/en as needed (don't forget to run git submodule update --init --recursive to fetch the theme and its dependencies).

Taxonomy Support

Taxonomies such as tags and categories work in the same way as they do with Docsy. They are disabled by default.

See the Docsy taxonomy support documentation for instructions.

mostlydocs's People

Contributors

deining avatar gwatts avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

mostlydocs's Issues

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.