Skip to content

The website for the Algonquian Components project

License

Notifications You must be signed in to change notification settings

digitallinguistics/Nisinoon.net

Repository files navigation

Nisinoon.net

The website for the Algonquian Components project.

How to edit site content

To edit the prose/copy on the website:

  1. On the GitHub page for the repository, find the page you wish to edit inside the src/pages folder, and click the file with the .md extension (e.g. Home.md).
  2. Click the edit icon (a pencil towards the top right).
  3. Edit the page content.
    • Pages are written in Markdown.
    • HTML is valid Markdown, so you can use HTML tags as well.
    • You can't use Markdown inside HTML tags. If you use an HTML tag, everything inside that tag needs to be written in HTML as well.
  4. At the top right of the page, clik the green "Commit changes..." button. A box will pop up where you can leave a message describing your changes.
    • Choose the "Commit directly to the main branch" option.
    • Click the green "Propose changes" button in the bottom right of the box.
  5. A new pull request draft will be started. Click the green "Create pull request" towards the bottom right.
  6. Wait for a developer to review your changes and merge them into the live version of the website.

How to update the bibliography page + PDF

Automatically

The bibliography updates automatically every Monday at 1:00 a.m. UTC.

Semi-Manually

  1. Go to https://github.com/digitallinguistics/Nisinoon.net/actions/workflows/gh-pages.yml.
  2. Click the "Run workflow" button (top right). Use the default settings.

Manually

Note: This is no longer necessary. Use the Semi-Manually option above instead.

  1. In Zotero, right click the Nisinoon group folder and select "Export Library".
    • Make sure the format is "BibTex" and the character encoding is "Unicode (UTF-8)".
    • Save the file somewhere you can easily locate it.
  2. Click here to edit the website's BibTeX file.
  3. Copy the contents of the file you exported from Zotero and paste them into GitHub (replacing the content that was there).
    • Use Ctrl/Cmd + A to select all the text at once.
  4. Click the "Commit Changes" button at the bottom of the page.
    • Select the "Commit directly to the main branch." option.

Archiving the bibliography with Zenodo

The bibliography in Zenodo needs to be manually updated.

Developer note: The version number in package.json will not be kept in sync with the version number of the release. It will stay at v0.1.0. This allows non-developers to create releases.

Generating the bibliography PDF

The bibliography PDF is automatically generated on CI during the build process.

You can also generate the PDF manually using npm run pdf, or by downloading Prince XML and running it on the Bibliography page.