Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neelsmith/citedown.jl
Use URNs in markdown links.
https://github.com/neelsmith/citedown.jl
cite-architecture
Last synced: about 1 month ago
JSON representation
Use URNs in markdown links.
- Host: GitHub
- URL: https://github.com/neelsmith/citedown.jl
- Owner: neelsmith
- License: gpl-3.0
- Created: 2021-11-19T10:54:10.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-26T01:46:06.000Z (about 3 years ago)
- Last Synced: 2024-11-14T17:06:24.640Z (about 2 months ago)
- Topics: cite-architecture
- Language: Julia
- Homepage: https://neelsmith.github.io/CiteDown.jl/stable/
- Size: 138 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CiteDown.jl
Use URNs in markdown links. The current version supports citing images by URN and using a [citable image service](https://cite-architecture.github.io/CitableImage.jl/stable/) to resolve URNs to image data.
## Quick example
(See the [documentation](https://neelsmith.github.io/CiteDown.jl/stable/) for full information.)
### Write markdown like this
```
---
ict: "http://www.homermultitext.org/ict2/?"
iiif:
service: "http://www.homermultitext.org/iipsrv"
path: "/project/homer/pyramidal/deepzoom"
maxheight: 500
---
Highlighted title:
```
### Generate markdown like this
Use the `rewrite` function to generate markdown with embedded images.Configuring the `ict` setting means that the displayed image will also be linked to an interactive image browser.
```
Highlighted title:
[](http://www.homermultitext.org/ict2/?urn=urn:cite2:hmt:vaimg.2017a:[email protected],0.1667,0.4738,0.04948)
```
### What you get
In a markdown environment like a github repository's README, that produces something like the following, with the embedded image linked to an external image browser.
> Highlighted title:
>
> [](http://www.homermultitext.org/ict2/?urn=urn:cite2:hmt:vaimg.2017a:[email protected],0.1667,0.4738,0.04948)
## Setting up a command-line script
Although you can use the CiteDown package's `rewrite` function in larger Julia programs, it can be handy to have a script you run from the command line to convert a markdown file with URN references to markdown with URLs. Create a file with the following contents:
```julia
using CiteDown
for f in ARGS
print(rewrite(f))
end
```
Then define an alias for your shell that invokes julia with options to optimize startup time. If you created the script file in `/usr/local/bin/citedown.jl` and are using `bash` or `zsh` for your shell, you can define an alias like this:
alias citedown="julia -O0 --compile=min --startup=no /usr/local/bin/citedown.jl"
You can then use the simple `citedown` alias from the command line. Redirect its output to create a new markdown file with URNs replaced by URLs:
citedown FILE.md > NEWFILE.md