Skip to content

Document Markdown publication export #710

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

Open
Ujjwals17 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document Markdown publication export #710

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63a4373
Document Markdown publication export
Ujjwals17 Oct 27, 2026
5709af5
Merge branch 'main' into patch-1
Ujjwals17 Oct 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion en/collaborative-work/export/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,51 @@

{% page-ref page="customexports.md" %}

## Markdown publications

The Markdown publications format exports a publication list for use on Markdown websites.

### Export a publication list

1. Open your library in JabRef.
2. Choose **File → Export** and select whether to export all entries or selected entries.
3. Select **Markdown publications** as the export format.
4. Choose a destination and save the `.md` file.

The output contains:

- **Recent publications:** up to five entries, newest first.
- **All publications:** all exported entries, newest first.

This format uses publication dates rather than the general export sort-order preference.
Dates include the year, month, and day where available.
Entries without a usable publication date appear last.

Each entry includes available authors, title, publication venue, and year.
The title links to the DOI when available, otherwise to the URL.

### Group publication sections

Create a group named **Export** and add subgroups for the publication sections you want.

Each subgroup description becomes its section heading.
If the description is blank, the subgroup name is used.

Check warning on line 41 in en/collaborative-work/export/README.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'is used' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'is used' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/export/README.md", "range": {"start": {"line": 41, "column": 48}}}, "severity": "WARNING"}
Nested subgroups produce nested headings.
Empty sections are omitted unless they contain a nonempty descendant section.

Check warning on line 43 in en/collaborative-work/export/README.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'are omitted' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'are omitted' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/export/README.md", "range": {"start": {"line": 43, "column": 16}}}, "severity": "WARNING"}

Only entries included in the export appear in these sections.

### PDF links

The exporter adds a link to the first usable PDF attachment.
Online PDFs retain their online links.

Check warning on line 50 in en/collaborative-work/export/README.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 🐶
[write-good.TooWordy] 'retain' is too wordy.

Raw Output:
{"message": "[write-good.TooWordy] 'retain' is too wordy.", "location": {"path": "en/collaborative-work/export/README.md", "range": {"start": {"line": 50, "column": 13}}}, "severity": "WARNING"}
Local PDFs use paths relative to the exported Markdown file.

When moving the export, preserve the relative arrangement of the Markdown file and local PDFs.
Local attachments that cannot be resolved or represented by a relative path are omitted.

Check warning on line 54 in en/collaborative-work/export/README.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'are omitted' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'are omitted' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/export/README.md", "range": {"start": {"line": 54, "column": 77}}}, "severity": "WARNING"}

Check warning on line 54 in en/collaborative-work/export/README.md

View workflow job for this annotation

GitHub Actions / vale-lint 

[vale] reported by reviewdog 🐶
[write-good.Passive] 'be resolved' may be passive voice. Use active voice if you can.

Raw Output:
{"message": "[write-good.Passive] 'be resolved' may be passive voice. Use active voice if you can.", "location": {"path": "en/collaborative-work/export/README.md", "range": {"start": {"line": 54, "column": 31}}}, "severity": "WARNING"}

See also:

{% page-ref page="../../collect/import/" %}

{% page-ref page="../../collect/import/customimports.md" %}

Loading