Code Monkey home page Code Monkey logo

Comments (8)

jcvernaleo avatar jcvernaleo commented on August 16, 2024

Would love comments on this from @dajohi, @jolan, @karamble, @gratefulcheddar, and anyone else interested.

from dcrdocs.

karamble avatar karamble commented on August 16, 2024

I agree. I have researched on the multilanguage issue on mkdocs and couldn't find a reliable solution. My first thought was the same, having multiple directories for the various languages including the full set of docs. We should keep the filenames of the .md files consistent over the language directories so it would be easier to track if the subpages are allready translated.

We also need a mkdocs.yml for each language. en_mkdocs.yml is my suggestion.

Also to make the work for the admin easier we can add a build-the-docs.sh bash script that handles the build process, renaming directories etc. So the admin would just need to point the virtualhosts of the subdomains to the specific language directories.


I will start translating into german and try to prepare the directory structure and the build bash script just to get a feeling for it, as i have only used the 'serve' function instead of building the docs yet.

from dcrdocs.

jcvernaleo avatar jcvernaleo commented on August 16, 2024

@karamble so sounds like you are in favor of option 2 above.

Anyone else want to chime in?

from dcrdocs.

jolan avatar jolan commented on August 16, 2024

I've looked at hugo a bit which seems suitable as a mkdocs replacement. They have a few ways of doing internationalization:

https://gohugo.io/content/multilingual/

I'm not sure it's really worth the effort to switch over since it would require porting the template to be hugo-compatible, having everyone learn golang template syntax, etc.

I am fine with what @karamble proposes. If we hit snags with that method then we can consider switching.

from dcrdocs.

gratefulcheddar avatar gratefulcheddar commented on August 16, 2024

I agree with @jolan. Was gonna throw Hugo out there as a suggestion but the work required to switch may not be worth it.

from dcrdocs.

dajohi avatar dajohi commented on August 16, 2024

I am fine with option 2. I strongly support subdirs over subdomains.

from dcrdocs.

jcvernaleo avatar jcvernaleo commented on August 16, 2024

Some experiments/initial work on this by @karamble are in #96

from dcrdocs.

jcvernaleo avatar jcvernaleo commented on August 16, 2024

This was done in #96

from dcrdocs.

Related Issues (20)

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.