Skip to content

Move Documentation into Markdown #4

New issue
New issue
Open
Open
Move Documentation into Markdown#4
Labels
documentationImprovements or additions to documentationhelp wantedExtra attention is needed

Description

@uvulpos
uvulpos
opened on Jul 29, 2023

As a user of this library, I want to be able to read the documentation based on the version

ACS:

  • there is a documentation in the code based on Markdown
  • it is possible to open it as a website

Activity

  1. uvulpos
    added
    documentationImprovements or additions to documentation
    help wantedExtra attention is needed
    on Jul 29, 2023

  2. alimy commented on Aug 7, 2023

    @alimy
    alimy
    on Aug 7, 2023

    how about docs site like go-mir docs site, it use hugo+Book theme to generate static site base on markdown documents.
    The generated static site is just simple for project's document but not well as a project offical site.
    docs for go-mir as a example to show Book theme for hugo and it support mutil-language translate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions