Coder Social home page Coder Social logo

document generator has some bugs about v HOT 7 CLOSED

despiegk avatar despiegk commented on May 24, 2024
document generator has some bugs

from v.

Comments (7)

4zv4l avatar 4zv4l commented on May 24, 2024 2

https://modules.vlang.io/toml.html

In the TOML stdlib doc, first code block, there are some issue with the generation as well:
image

from v.

medvednikov avatar medvednikov commented on May 24, 2024 1

There still seems to be an issue with search when running locally:

funny if I go in & out of a folder at left, I get some search to work, but at start not

hmmm most of cases I can't get it to work

might have something to do with readme exists

when I click on e.g. bizmodel left, then search works

Can you have a look at it please @ttytm ?

Thanks

from v.

ttytm avatar ttytm commented on May 24, 2024 1

I'll look into it.

modules.vlang.io/toml.html

In the TOML stdlib doc, first code block, there are some issue with the generation as well: image

This one is still there since it has the language specified with v ignore. Currently the unescape became part of the v / vlang only code block. It could be solve by not escaping all ``` md_block_codes's. But I also realised that this is not the correct solution for everything. It can break some readme html outputs. The escaping needs to be made more selectively. Need to investigate

from v.

JalonSolov avatar JalonSolov commented on May 24, 2024

This was just fixed in #21220

from v.

spytheman avatar spytheman commented on May 24, 2024

The indentation is fixed in #21220, but & and > are still not properly shown as & and > in the code blocks.

from v.

ttytm avatar ttytm commented on May 24, 2024

Yes, there is a issue with multiline examples. Not just in the readme.

// Example: my_ch <- true // is okay
pub fn foo() {

// Example: 
// ```v
// my_ch <- true // `<` will be rendered as `&lt;`
// ```
pub fn foo() {

from v.

ttytm avatar ttytm commented on May 24, 2024

The search issue on an index.html page when generating docs with -readme is still present. This is how it always was - at least from the first time I have generated such a readme page I noticed that. On module pages there are no issues - readme included or not.

I'd have to look into it to tell about the amount of work this will require to fix. If it's not fitting now, maybe just making clear via it's attributes and style that the search is disabled on such readme html pages would do for now. What do you think?

from v.

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.