Giter VIP home page Giter VIP logo

Comments (8)

Nooo37 avatar Nooo37 commented on August 26, 2024 2

Docsify is very good looking and probably more appealing than a github wiki. We should just make sure to add support for lua syntax highlighting because especially longer code blocks like the ones on the declarative wallpaper module become unreadable without it.

from bling.

heavyrain266 avatar heavyrain266 commented on August 26, 2024

I think wiki section with pages for each module is enough. Alternativelyy we can create website hosted on github with documentation website generator like this https://docsify.js.org/#/

from bling.

javacafe01 avatar javacafe01 commented on August 26, 2024

we can create website hosted on github with documentation website generator like this https://docsify.js.org/#/

I like this generator, so far with our current readme it looks like this:

image

from bling.

heavyrain266 avatar heavyrain266 commented on August 26, 2024

Actually this is very nice, now we wait fro @Nooo37 comment on this, also mayby we should remove emojis looks a bit weird on website?

from bling.

javacafe01 avatar javacafe01 commented on August 26, 2024

We should just make sure to add support for lua syntax highlighting because especially longer code blocks like the ones on the declarative wallpaper module become unreadable without it.

Yup, it uses prism for syntax highlighting.
image

from bling.

javacafe01 avatar javacafe01 commented on August 26, 2024

@branwright1 @Nooo37 i finished the docs up in the docs branch, take a look if there are any edits needed or if there is anything i forgot

also @Nooo37 if this is all good i think u should host it on github

from bling.

heavyrain266 avatar heavyrain266 commented on August 26, 2024

For now I found only 2 problems:

  • Images/gifs at the top can take a while to be loaded or sometimes need to reload website in order to see them
  • I think this text should be above gif or under it because looks a bit weird compared to other pages.
    img

Small suggestion:

  • Reduce a bit size of preview images/gifs on every pages, they are too big imo.
  • img

from bling.

javacafe01 avatar javacafe01 commented on August 26, 2024

done with #21 , will reduce size @branwright1

from bling.

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.