hinode icon indicating copy to clipboard operation
hinode copied to clipboard

Enhance documentation

Open markdumay opened this issue 2 years ago • 2 comments

Is your feature request related to a problem? Please describe. Hinode's documentation provides an overview on how to get started, how to configure the theme, and how to use the available shortcodes.

Describe the solution you'd like Expand the documentation for the following topics:

Configuration

  • [ ] Comments

Advanced settings

  • [ ] Metadata

Forms

  • [ ] Overview
  • [ ] Form control
  • [ ] Select
  • [ ] Checks & radios
  • [ ] Range
  • [ ] Input group
  • [ ] Floating labels
  • [ ] Layout
  • [ ] Validation

Components

  • [ ] Overview
  • [ ] Close button
  • [ ] Dropdowns
  • [ ] List group
  • [ ] Modal
  • [x] Navs & tabs
  • [ ] Offcanvas
  • [ ] Pagination
  • [ ] Placeholder
  • [ ] Popover
  • [ ] Progress
  • [ ] Scrollspy

Component examples

  • [x] Accordion
  • [x] Alert
  • [x] Badge
  • [x] Breadcrumb
  • [x] Button
  • [x] Button group
  • [x] Card
  • [x] Carousel
  • [x] Collapse
  • [x] Command prompt
  • [x] Icon
  • [x] Image
  • [x] Navbar
  • [x] Navs and tabs
  • [x] Spinner
  • [x] Toast
  • [x] Tooltip

Describe alternatives you've considered N/A

Additional context N/A

markdumay avatar Feb 03 '23 06:02 markdumay

I think it would be good to add to the Hinode documentation, how to disable multi language support. It took me some time to figure out the Hugo pages had that info (I know you did link to that page). Even though Dutch is my native language, it is too much work to support it next to English, so I wanted to disable the drop-down. The missing information would be to add disableLanguages = ['nl'] to config.toml, so that only one language is left. This would probably go hand in hand with the defaultContentLanguageInSubdir = false setting and contentDir = "content" in languages.toml. The latter option only if you do not want want to keep the content in the content/en folder.

Maybe there is another option to disable it, but I could not figure it out (besides hacking the navbar partial).

Update: I see there is information about this in the guide about documentation.

myrthos avatar Jul 04 '23 13:07 myrthos

I moved the content from the guide to the language configuration and made a reference to it, so it can be found better.

markdumay avatar Jul 06 '23 04:07 markdumay