Skip to content

Commit

Permalink
feat: initial version
Browse files Browse the repository at this point in the history
## Summary by CodeRabbit

- **New Features**
  - Introduced configuration settings for a manuscript project with HTML, DOCX, and PDF outputs.
  - Added new bibliographic entries related to metadata and cultural heritage.

- **Updates**
  - Rebranded repository to `diskriminierungsfreie-metadaten` with updated URLs, badges, and support information.
  - Updated contact emails in `CODE_OF_CONDUCT.md` and `SECURITY.md`.
  - Modified `.gitignore` to reflect new directory structure.
  - Updated `CHANGELOG.md` and `cliff.toml` with new repository details.
  - Added styling changes for manuscript printing.

- **Improvements**
  - Simplified GitHub Actions workflow for Quarto publishing.
  - Enhanced `.prettierrc` with overrides for `.qmd` files.

---------

Co-authored-by: noelleschnegg <[email protected]>
  • Loading branch information
maehr and noelleschnegg authored Jun 2, 2024
1 parent 01c6065 commit f1253df
Show file tree
Hide file tree
Showing 56 changed files with 2,998 additions and 501 deletions.
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
contact_links:
- name: Are you looking for documentation on REPO_NAME?
url: https://USERNAME.github.io/REPO_NAME
about: Please see the documentation for REPO_NAME on its GitHub Pages page.
- name: Do want to discuss REPO_NAME with the community?
url: https://github.com/USERNAME/REPO_NAME/discussions
about: Please see the discussions page for REPO_NAME.
- name: Are you looking for documentation on diskriminierungsfreie-metadaten?
url: https://maehr.github.io/diskriminierungsfreie-metadaten
about: Please see the documentation for diskriminierungsfreie-metadaten on its GitHub Pages page.
- name: Do want to discuss diskriminierungsfreie-metadaten with the community?
url: https://github.com/maehr/diskriminierungsfreie-metadaten/discussions
about: Please see the discussions page for diskriminierungsfreie-metadaten.
blank_issues_enabled: true
63 changes: 14 additions & 49 deletions .github/workflows/quarto-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ on:

name: Render and Publish

# you need these permissions to publish to GitHub pages
permissions:
contents: write
pages: write
Expand All @@ -28,58 +27,24 @@ jobs:
uses: quarto-dev/quarto-actions/setup@v2
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# with:
# To install LaTeX to build PDF book outputs, uncomment below
# tinytex: true
# uncomment below and fill to pin a version
# version: SPECIFIC-QUARTO-VERSION-HERE

# add software dependencies here and any libraries

# From https://github.com/actions/setup-python
# - name: Setup Python
# uses: actions/setup-python@v3

# From https://github.com/r-lib/actions/tree/v2-branch/setup-r
# - name: Setup R
# uses: r-lib/actions/setup-r@v2

# From https://github.com/julia-actions/setup-julia
# - name: Setup Julia
# uses: julia-actions/setup-julia@v1

# See more at https://github.com/quarto-dev/quarto-actions/blob/main/examples/example-03-dependencies.md

# To publish to Netlify, RStudio Connect, or GitHub Pages, uncomment
# the appropriate block below
with:
tinytex: true

# - name: Publish to Netlify (and render)
# uses: quarto-dev/quarto-actions/publish@v2
# with:
# target: netlify
# NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
- name: Render Quarto Project
uses: quarto-dev/quarto-actions/render@v2
with:
path: manuscript
to: all

# - name: Publish to RStudio Connect (and render)
# uses: quarto-dev/quarto-actions/publish@v2
# with:
# target: connect
# CONNECT_SERVER: enter-the-server-url-here
# CONNECT_API_KEY: ${{ secrets.CONNECT_API_KEY }}
- name: Convert html to pdf with Chromium
run: |
chromium --headless --disable-gpu --print-to-pdf=manuscript/_manuscript/handbuch-diskriminierungsfreie-metadaten.pdf --scale=1.0 --no-pdf-header-footer --print-background --virtual-time-budget=10000 file:///$(pwd)/manuscript/_manuscript/index.html
# NOTE: If Publishing to GitHub Pages, set the permissions correctly (see top of this yaml)
- name: Publish to GitHub Pages (and render)
- name: Publish to GitHub Pages
uses: quarto-dev/quarto-actions/publish@v2
with:
path: manuscript
target: gh-pages
render: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # this secret is always available for github actions


# - name: Publish to confluence
# uses: quarto-dev/quarto-actions/publish@v2
# with:
# target: confluence
# env:
# CONFLUENCE_USER_EMAIL: ${{ secrets.CONFLUENCE_USER_EMAIL }}
# CONFLUENCE_AUTH_TOKEN: ${{ secrets.CONFLUENCE_AUTH_TOKEN }}
# CONFLUENCE_DOMAIN: ${{ secrets.CONFLUENCE_DOMAIN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Quarto
.quarto/
_site/
manuscript/.quarto/
manuscript/_manuscript/

# Exclude example.env
!example.env
Expand Down
10 changes: 9 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,13 @@
"useTabs": true,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100
"printWidth": 100,
"overrides": [
{
"files": "*.qmd",
"options": {
"parser": "markdown"
}
}
]
}
19 changes: 1 addition & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,8 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://github.com/USERNAME/REPO_NAME/compare/...HEAD)

### Documentation

- Docs for Zenodo added
- Fixed various typos and replaced favicon
## [Unreleased](https://github.com/maehr/diskriminierungsfreie-metadaten/compare/...HEAD)

### Features

- Initial version

## [0.0.2](https://github.com/USERNAME/REPO_NAME/compare/v0.0.1...v0.0.2) - 2020-02-26

### Documentation

- ...

## [0.0.1](https://github.com/USERNAME/REPO_NAME/releases/tag/v0.0.1) - 2020-01-13

### Features

- ...
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
Loading

0 comments on commit f1253df

Please sign in to comment.