Giter Club home page Giter Club logo

perplexdoc's Introduction

Netlify Status

Documentation and Demo for the Perplex theme

Perplex is a typographic theme for technical publishing with Hugo.

The theme is included in this documentation project as a module from https://github.com/bowman2001/perplex. You don’t need a Golang environment to build because there is always a recent copy available in the _vendor path.

perplexdoc's People

Contributors

bowman2001 avatar

Stargazers

Timo Jaspers avatar Celestial.y avatar Celestial-Entity avatar  avatar Daniel F. Dickinson avatar Roneo.org avatar  avatar

Watchers

James Cloos avatar  avatar Daniel F. Dickinson avatar

perplexdoc's Issues

400 page is in lists of pages

This can be avoided easily (while still leaving it rendered for an actual 400 Not Found situation) by adding:

_build:
  list: never

to the frontmatter of the 400/index.md file.

It probably should also be excluded from search, but I'm not sure how to do that yet.

Title section

Explain the content generation for:

  • Short breadcrumbs
  • Page title
  • Subtitle
  • Date of first publication, which should also link to the GitHub source

highlight shortcode

Where is the best place to document the highlighting shortcode?

  • Besides the syntax of fenced code blocks (basic -> code)
  • In shortcode -> built-in -> internal

Archetypes

Describe different types of archetypes for single content files and page bundles.

Site Navigation

The navigation is generated from front-matter parameters. There purpose and function needs to be documented.

  • title
  • description
  • menu (different kinds of)
  • weights (page weight or menu weight)
  • taxonomies

Preview (TL;DR)

  • List the current features of Perplex

  • Get the standard Markdown page for Hugo themes

  • Add notes leading to alternatives provided by Perplex

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.