The Wayback Machine - https://web.archive.org/web/20210425111156/https://github.com/topics/documentation
Skip to content
#

Documentation

Documentation is a set of information that describes a product to its users, including what it is, how it operates, and how to use it.

Here are 6,912 public repositories matching this topic...

storybook
cmsbased
cmsbased commented Apr 21, 2021

What's the problem?

I have successfully customized my storybook with addon-themes and created the dark style for div with a .docs-story class.

I tried to style the "show code" button on the docs tab without luck via CSS in preview-head.html.

The problem is that there is no unique CSS class to scope (only dynamically generated classes):

<div class="css-11xgcgt">
<button c
docusaurus
slorber
slorber commented Apr 9, 2021

🚀 Feature

We should validate docs/blog/pages frontmatter against a Joi schema:

  • prevent the user to use bad frontmatter
  • display friendly error messages when this happens
  • allow unknown frontmatter (user can assign additional metadata to each doc)
  • unit-test this validation logic
  • try to use the frontmatter TS types in the theme?

Some initial work has been done in https://gith

react-styleguidist
typedoc
RunDevelopment
RunDevelopment commented Apr 12, 2021

After renaming some functions, I noticed that the documentation website contained some broken links. E.g. {@link Foo} wasn't linked because Foo got renamed and instead, the website contained the literal text "{@ link Foo}".

I searched for an option to a) get all invalid symbols and b) a way to fail the build if it contains invalid symbols so this doesn't happen again.

The `--listInvalidS

Wikipedia
Wikipedia