Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing links not found in asciidoc files #29

Open
marcindulak opened this issue Feb 17, 2024 · 1 comment
Open

Missing links not found in asciidoc files #29

marcindulak opened this issue Feb 17, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@marcindulak
Copy link
Contributor

The example below uses docker #23

  1. build the image of the latest linkspector from source
    git clone https://github.com/UmbrellaDocs/linkspector
    cd linkspector
    docker build --build-arg LINKSPECTOR_PACKAGE= -t umbrelladocs/linkspector .
    
  2. run linkspector check on a test directory
    mkdir -p test/nested
    cp .gitignore test  # due to https://github.com/UmbrellaDocs/linkspector/issues/24
    echo 'footnote:[linkspector-mising[https://github.com/UmbrellaDocs/linkspector-missing]]' > test/nested/nested.asciidoc # 1
    echo 'link:nested/nested-missing.asciidoc[nested-missing]' > test/test.asciidoc # 2
    echo '[[test-missing.png]]' >> test/test.asciidoc
    echo 'image::test-missing.png[test-missing]' >> test/test.asciidoc # 3
    echo '<<test-missing-missing.png>>' >> test/test.asciidoc # 4
    docker run --rm -it -v $PWD/test:/app --name linkspector umbrelladocs/linkspector bash -c 'linkspector check'
    

Output

⠋ Configuration file not found. Using default configuration.
✨ Success: All hyperlinks in the specified files are valid.
⠋ Configuration file not found. Using default configuration.

It is expected that 'linkspector check' fails for the above 4 types of missing links.
There are more types of links, but I think these are the most common ones.

@gaurav-nelson
Copy link
Contributor

Thank you @marcindulak I have a WIP branch for adding AsciiDoc link checking, however, I first want to focus on handling MarkDown better. I'll pick up AsciiDoc soon.

@gaurav-nelson gaurav-nelson added the bug Something isn't working label May 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: In Progress
Development

No branches or pull requests

2 participants