Comments (2)
adoble
commented on July 17, 2024
This is proving more challenging than originally thought. To create a link between two existing ADRs, some meta information needs to be maintained in the ADR to show:
-
Where the link has to be created
-
What markup is associated with that link.
Currently once an ADR has been created, the fields for links such as {{{link.id}}} (a.k.a. the meta information) is overwritten. This needs to be preserved, but in a way that does not interfere with the markdown. Currently Iām looking at adding this information as markup comments. In addition, it would be nice to also preserve the semantics of what has been changed. In this way, future (sub)commands could, for instance, create a graph of the links.
As this seems to be a general problem - annotating markup with semantic information - I have started a new project semplate that should handle this as a library. If all goes to plan, I can link this into this project.
from adr-j.
Related Issues (20)
- Long option names HOT 1
- Rename "doc" folder to "docs" HOT 1
- Have an edit command HOT 1
- Generate man page
- Publish on Homebrew HOT 5
- Add author field substitution HOT 2
- build.gradle does not run unit tests
- Use ISO_LOCAL_DATE format HOT 2
- Specifing templates as test resources does not run correctly in local IDE unit tests
- Native build broken HOT 1
- Remove references to jcenter
- Error when a new ADR has the word "superceded" or similar in the titel HOT 1
- What does reverse_link_description in "adr new -l" do? HOT 2
- {{{link.file}}} is not resolved when using Asciidoc templates
- Not clear from documentation that other markup formats such as ASCIIDOC can be used.
- Update ADR 2
- numberformatexception on new HOT 4
- consider providing jbang catalog for easy usage HOT 3
- Command help not always correctly rendered in windows terminal HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
š Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ā¤ļø Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from adr-j.