GithubHelp home page GithubHelp logo

hajnyon / middleman-uikit-documentation-template Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 809 KB

๐Ÿ“’ Template for documentation pages styled with UIkit for Middleman SSG.

Home Page: https://hajnyon.gitlab.io/middleman-uikit-documentation-demo/

License: MIT License

Ruby 22.29% JavaScript 1.84% HTML 67.72% SCSS 8.15%
ssg template docs documentation uikit middleman middleman-template

middleman-uikit-documentation-template's People

Contributors

hajnyon avatar

Stargazers

 avatar  avatar

Watchers

 avatar

middleman-uikit-documentation-template's Issues

Navbar links

Navbar link ignore baseUrl such as https://software.fiedler.corp/documentation/cloud/docs/dev/ui-ux-style/docs/dev/ui-ux-style

Localization

Add default support for middleman localization.

Search

Choose extension and add partial/layout for search.

Assets and subfolders displayed in contents layout and left sidebar

current_page.children contains all subfolders, images etc and therefore they are displayed in contents layout and left sidebar in documentation layout. It need to be resolved propably by filtering the current_page.children in order_pages function.

Images can be solved by putting them in folder images on the same level.

Right sidebar

Add optional right sidebar with second level headings links ala UIkits or Docusaurus.

Missing git last updated date

When git log returns no info (not tracked file) last_update_time method returns empty string which then cannot be converted to date.

Versioning and updating of template

Version

As of now there is no version kept anywhere in the template files. Therefore users don't know which version their project use and if they should update.

Updating

So far I wasn't able to find any other way how to update the template in existing project other than initialize it again with middleman init MY_PROJECT_FOLDER -T hajnyon/middleman-uikit-documentation-template and then handle the possible overwrite of template files. If anyone knows about other way, please tell me.

Responsiveness

  • reorder footer
  • better styling of sidebar and breadcrumbs in documentation layout (breadcrumbs first etc)
  • make GitLab SSE edit link smaller

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.