GithubHelp home page GithubHelp logo

Comments (5)

yukiisbored avatar yukiisbored commented on June 28, 2024

Here's the how-to, I hope it'll clear some ambiguity and questions. https://github.com/loklak/dev.loklak.org/wiki/How-to-add-documentations-to-dev.loklak.org

from dev.loklak.org.

mariobehling avatar mariobehling commented on June 28, 2024

In the "how to" you write:

Make sure the documentation is a static website and it’s located in a separated branch in the repository.

This is not the case for the loklak_server repository. Am I missing something?

from dev.loklak.org.

mariobehling avatar mariobehling commented on June 28, 2024

Sorry, yes it is.

Still that is a bit complicated process:
a) There has to be a static site generated as a branch.
b) The static site is again generated in the dev site.

This kind of process has a great potential to confuse people and search engines.

from dev.loklak.org.

mariobehling avatar mariobehling commented on June 28, 2024

What are the options to generate the site directly from a Readme.md and /docs branch of repositories?

from dev.loklak.org.

yukiisbored avatar yukiisbored commented on June 28, 2024

@mariobehling You can use static page generators like Jekyll, Pelican, etc or Sphinx which is made for documentation. The reason why it's designed this way is because the documentation are expected to be stored as Github pages.

from dev.loklak.org.

Related Issues (9)

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.