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.

Sign up for GitHub

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

Jump to bottom

Add anchor to configuration options in documentation #533

Closed
1 of 3 tasks
abelsromero opened this issue Jul 2, 2021 · 2 comments · Fixed by #551
Closed
1 of 3 tasks

Add anchor to configuration options in documentation #533

abelsromero opened this issue Jul 2, 2021 · 2 comments · Fixed by #551
Labels
documentation

Comments

@abelsromero
Copy link
Member

Thank you for taking your time to talk with us!

What is this issue about?

  • Bug report
  • Feature request
  • Question

Description
Is not possible to share a pointer to a specific configuration option using a url. That's cumbersome because the page is relatively long so users need to navigate and then search for it by name.
@uniqueck
Copy link
Member

Hi @abelsromero, do we have a preview site, so that i can check for working anchors?

uniqueck added a commit to uniqueck/asciidoctor-maven-plugin that referenced this issue Jul 26, 2021
@uniqueck
add anchor for each parameter
a5b9e8c 
asciidoctor#533
@uniqueck uniqueck mentioned this issue Jul 26, 2021
Merged
8 tasks
uniqueck added a commit to uniqueck/asciidoctor-maven-plugin that referenced this issue Jul 26, 2021
@uniqueck
add entry for asciidoctor#533 to CHANGELOG.adoc
2405c31
uniqueck added a commit to uniqueck/asciidoctor-maven-plugin that referenced this issue Jul 26, 2021
@uniqueck
add anchor for each parameter (asciidoctor#533)
41ec677 
- process-asciidoc goal
- auto-refresh goal
- http goal
uniqueck added a commit to uniqueck/asciidoctor-maven-plugin that referenced this issue Jul 26, 2021
@uniqueck
add entry for asciidoctor#533 to CHANGELOG.adoc
6d48d9a
@abelsromero
Copy link
Member Author

Hi @abelsromero, do we have a preview site, so that i can check for working anchors?

I tend to build locally installing Antora and using this config file

site:
  title: 'Asciidoctor docs'
content:
  sources:
    - url: .
      branches: [ YOUR BRANCH ]
      start_path: docs
asciidoc:
  attributes:
    page-pagination: ''
    idprefix: ''
    idseparator: '-'
    experimental: ''
ui:
  bundle:
    url: https://github.com/asciidoctor/docs.asciidoctor.org-ui/releases/download/prod-249/ui-bundle.zip
    snapshot: true
  supplemental_files:
    - path: ui.yml
      contents: |
        static_files: [ .nojekyll ]
    - path: .nojekyll

uniqueck added a commit to uniqueck/asciidoctor-maven-plugin that referenced this issue Jul 28, 2021
@uniqueck
add anchor for each parameter (asciidoctor#533)
1a489b1 
- process-asciidoc goal
- auto-refresh goal
- http goal
uniqueck added a commit to uniqueck/asciidoctor-maven-plugin that referenced this issue Jul 28, 2021
@uniqueck
add entry for asciidoctor#533 to CHANGELOG.adoc
6620b4a
abelsromero pushed a commit that referenced this issue Jul 29, 2021
@uniqueck
Add anchor to configuration options in documentation (#551)
90bcfc5 
* add anchor for each parameter (#533)
- process-asciidoc goal
- auto-refresh goal
- http goal
* fix callout number
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add anchor to configuration options in documentation uniqueck/asciidoctor-maven-plugin
2 participants
@abelsromero @uniqueck