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.

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

Create "homepage" (and shorten README.md) #142

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 8 additions & 3 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,19 @@ jobs:
uses: actions/checkout@v4
with:
show-progress: ''

- name: Install TeX Live
uses: zauguin/install-texlive@v3
with:
package_file: Texlivefile

- name: Generate lni.cls, *.tex, ...
run: |
pdflatex lni.ins
pdflatex lni.dtx
pdflatex lni.dtx
pdflatex lni.dtx

- name: Check for modifications
run: |
git update-index --refresh
Expand Down Expand Up @@ -66,19 +69,21 @@ jobs:
*.log

- name: Prepare GH pages content
if: github.ref == 'refs/heads/main' && matrix.engine == 'lualatex'
if: matrix.engine == 'lualatex'
run: |
set -e
mkdir /tmp/gh-pages
cp README.md /tmp/gh-pages/index.md
cp docs/* /tmp/gh-pages/
rm /tmp/gh-pages/README.md
cp *.pdf /tmp/gh-pages

- name: Deploy to GH pages
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main' && matrix.engine == 'lualatex'
if: matrix.engine == 'lualatex'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: /tmp/gh-pages
enable_jekyll: true

- name: Install dependencies for ctanify
if: matrix.engine != 'lualatex'
Expand Down
24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,14 @@ See: http://www.latex-project.org/lppl.txt
This is the official version of the class “lni” for submissions to the
“[Lecture Notes in Informatics]” published by the “Gesellschaft für Informatik”
([GI]).

It is based on previous templates created on behalf of the GI.

Quick start:
Download [`lni-author-template.tex`](lni-author-template.tex) and edit it in
your favorite LaTeX editor.
By default [BibTeX](https://www.ctan.org/pkg/bibtex) is used as bibliography tool.
In case you want to use [biblatex](https://www.ctan.org/pkg/biblatex) together with
[Biber](https://www.ctan.org/pkg/biber) (strongly recommended), read on in the
documentation. There is a specialized package
[biblatex-lni](https://ctan.org/pkg/biblatex-lni), which can easily be included
to get correctly formed bibliographies. The easiest way is to add `biblatex` as class
option. See documentation for details.

You should use `pdflatex` as `xelatex` and `lualatex` lack some features of the class file.

Stable versions are always uploaded to CTAN and available at <https://www.ctan.org/pkg/lni>.
In addition, you will find the most recent developer version on GitHub at https://github.com/gi-ev/lni.
The most recent documentation is available at <https://gi-ev.github.io/LNI/lni.pdf>.
It includes a short description how to use the template and also provides troubleshooting hints.
## Links

Please see [`CHANGELOG.md`](CHANGELOG.md) for a version history
- Documentation on the web, includes a quick start: <https://gi-ev.github.io/LNI/>
- Developer repository: <https://github.com/gi-ev/LNI>
- Official CTAN page: <https://www.ctan.org/pkg/lni>
- Version history: [`CHANGELOG.md`](CHANGELOG.md)

[GI]: https://gi.de/
[Lecture Notes in Informatics]: https://gi.de/service/publikationen/lni
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Documentation for LNI

This directory is used as basis for <https://gi-ev.github.io/LNI/>.

Inputs are

- `index.md` (in this directory)
- `*.pdf` (generated in the `build` job in `.github/workflows/check.yml`).

The publishing is also done in the `build` job.
34 changes: 34 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
---

# A LaTeX class for submissions to the ``Lecture Notes in Informatics''

## Quick start

Download [`lni-author-template.tex`](https://github.com/gi-ev/LNI/blob/main/lni-author-template.tex) and edit it in your favorite LaTeX editor.

## Improved usage

By default [BibTeX](https://www.ctan.org/pkg/bibtex) is used as bibliography tool.
In case you want to use [biblatex](https://www.ctan.org/pkg/biblatex) together with [Biber](https://www.ctan.org/pkg/biber) (strongly recommended), use the specialized package [biblatex-lni](https://ctan.org/pkg/biblatex-lni).
The easiest way is to add `biblatex` as class option - or to directly start at `lni-paper-example-de.tex`.

## Links

The following links are based on the current development state.

- Longer German paper example: [`lni-paper-example-de.tex`](https://github.com/gi-ev/LNI/blob/main/lni-paper-example-de.tex).
You will also need [`lni-paper-example-de.bib`](https://github.com/gi-ev/LNI/blob/main/lni-paper-example-de.bib).
The PDF is available at [`lni-paper-example-de.pdf`](https://gi-ev.github.io/LNI/lni-paper-example-de.pdf).
- Rendered `lni-author-template.tex`: [`lni-author-template.pdf`](https://gi-ev.github.io/LNI/lni-author-template.pdf).
- Documentation: [`lni.pdf`](https://gi-ev.github.io/LNI/lni.pdf). It includes a short description how to use the template and also provides troubleshooting hints.
- Changes: [`CHANGELOG.md`](https://github.com/gi-ev/LNI/blob/main/CHANGELOG.md#changelog) for a version history.
- Stable versions: Always uploaded to CTAN and available at <https://www.ctan.org/pkg/lni>.
- Developer version: On GitHub at <https://github.com/gi-ev/lni>.

## Note

You should use `pdflatex` as `xelatex` and `lualatex` lack some features of the class file.

[GI]: https://gi.de/
[Lecture Notes in Informatics]: https://gi.de/service/publikationen/lni
Binary file removed lni-instructions.pdf
Binary file not shown.
Loading