/dhqwords

dhq content published with hugo/startwords

Primary LanguageJavaScript

DHQwords is a mashup of DHQ (Digital Humanities Quarterly) and Startwords.

Articles from DHQ have been converted from TEI XML to markdown for publication as Hugo site using the Startwords theme.

DHQ content is (generally) published under the Creative Commons Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0) license. Making that content available in a different format is expressly allowed by all CC licenses, including those with the No Derivatives clause. See the answer to Can I take a CC-licensed work and use it in a different format? in the Creative Commons FAQ.

Startwords is a research periodical irregularly published by the Center for Digital Humanities at Princeton. Read more about Startwords editorial and technical work.

License Hugo Node version

Developing

Hugo setup

To run the site locally for development, first follow the instructions to install Hugo. You can check that Hugo is installed with:

$ hugo version

this should output version info like:

Hugo Static Site Generator v0.116.0/extended darwin/amd64 BuildDate: unknown

check that the version you installed is at least as new as the version shown in the hugo badge at the top of this file.

importing DHQ content

(notes todo)

Static files

After hugo is installed, you'll need to install the javascript dependencies that are used to compile the site's static files. To check if you have node installed:

$ node --version

This should output a version string that is at least as new as the version shown in the node badge at the top of this file. To install dependencies, run npm in the project's root directory:

$ npm install

If the install completes without errors, you're ready to build the site for development.

Serving locally

To run a development server with auto-reload:

$ hugo server -D

You should see some debug output, followed by:

Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Open a web browser to the above address to see a local version of the site. When you make changes and save files locally, hugo will automatically refresh the page.

License

Content

Content published in DHQ is licensed under the Creative Commons Attribution 4.0 N-Derivatives International License (CC-BY-ND).

Software

Software included in Startwords is licensed under the Apache 2.0 License.