From 8d83ccc6355df466c698ebd0e0c5f46b1f78b9b5 Mon Sep 17 00:00:00 2001 From: Florian Matter Date: Thu, 9 Nov 2023 16:25:56 -0800 Subject: [PATCH] rename --- README.md | 10 +++++----- docs/scripts/dict_audio_path.md | 4 ++++ docs/tags.md | 0 mkdocs.yml | 11 +++++++++-- requirements.txt | 4 +++- 5 files changed, 21 insertions(+), 8 deletions(-) create mode 100644 docs/tags.md diff --git a/README.md b/README.md index 7b0c1f2..5ae8102 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -# FLEx script collection -This is a collection of scripts for SIL's [FieldWorks](https://software.sil.org/fieldworks/) projects. -Download a [ZIP](https://github.com/fmatter/flex-script-collection/archive/refs/heads/main.zip) from or clone the repository: +# Language documentation script collection +This is a collection of scripts for common language documentation workflows. +Download a [ZIP](https://github.com/fmatter/langdoc-script-collection/archive/refs/heads/main.zip) from or clone the repository: ``` -git clone https://github.com/fmatter/flex-script-collection +git clone https://github.com/fmatter/langdoc-script-collection ``` See pages for individual scripts for usage instructions. It is recommended to use a [virtual environment](https://docs.python.org/3/library/venv.html) to install necessary packages. ## Contribute a new script -To add a script to the collection, [fork the github repository](https://github.com/fmatter/flex-script-collection/fork), use a [virtual environment](https://docs.python.org/3/library/venv.html) to `pip install -r requirements.txt`, and add the following files to your fork: +To add a script to the collection, [fork the github repository](https://github.com/fmatter/langdoc-script-collection/fork), use a [virtual environment](https://docs.python.org/3/library/venv.html) to `pip install -r requirements.txt`, and add the following files to your fork: 1. a `my_script.py` (or other suffix) file, ideally with: * name and contact info diff --git a/docs/scripts/dict_audio_path.md b/docs/scripts/dict_audio_path.md index b844b9a..495dbb6 100644 --- a/docs/scripts/dict_audio_path.md +++ b/docs/scripts/dict_audio_path.md @@ -1,3 +1,7 @@ +--- +tags: + - flex +--- # Add prefix to audio path (`.lift`) This script iterates a `.lift` export and modifies the `href` attribute of every `media` tag. This is where paths to audio files are stored. diff --git a/docs/tags.md b/docs/tags.md new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yml b/mkdocs.yml index be4d720..35f2a67 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,11 +1,18 @@ -site_name: FLEx script collection -repo_url: https://github.com/fmatter/flex-script-collection +site_name: Language documentation script collection +repo_url: https://github.com/fmatter/langdoc-script-collection plugins: - search + - tags: + tags_file: tags.md # - mkdocstrings - include-markdown + - git-authors + - git-revision-date-localized extra_css: - style.css +extra: + tags: + flex: SIL's [FieldWorks](https://software.sil.org/fieldworks/) theme: name: material features: diff --git a/requirements.txt b/requirements.txt index f1c8068..ac02104 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,6 @@ mkdocs pymdown-extensions mkdocs-material -mkdocs-include-markdown-plugin \ No newline at end of file +mkdocs-include-markdown-plugin +mkdocs-git-authors-plugin +mkdocs-git-revision-date-localized-plugin \ No newline at end of file