hcts-hra / heidenc

heidenc webpage

heidENC

Bibliography of Chinese Encyclopaedic Works 1840-1937, their Japanese and Western Models and Sources.

This repo contains the contents of the last archived word document converted to markdown to deploy a statically hosted webpage.

The original project has been split into three parts:

• This Repo.
• A data repo for professionally typed .txt files of primary sources (incomplete)
• a Data publication for binary files

Development

Corrections and contributions to the bibliography are welcome:

1. Follow the instructions below to start a local copy of the webpage.
2. Edit contents
3. Open a pull request

Requirements

• Hugo

To install Hugo please follow the steps outlined in their documentation for your platform.

Local Installation

Before you can get a copy of the webpage up and running locally on your machine, you need to clone this repo. The blowfish theme is installed as a submodule.

git clone --recurse-submodules --remote-submodules https://github.com/hcts-hra/heidenc.git

If you forgot to include the submodule flags when cloning the repo run the following:

git submodule update --init

To just update the theme.

git submodule update --remote --merge

Building

To build a local dev version run:

hugo server -D  

You should see something like this:

                   | EN   
-------------------+------
  Pages            |  57  
  Paginator pages  |   0  
  Non-page files   |   0  
  Static files     | 218  
  Processed images |   0  
  Aliases          |  11  
  Sitemaps         |   1  
  Cleaned          |   0  

Built in 150 ms
Watching for changes in ~/Documents/GitHub/heidenc/{archetypes,content,static,themes}
Watching for config changes in ~/Documents/GitHub/heidenc/config.toml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

Congratulations, the page is visible in your browser at http://localhost:1313/

heidenc's Issues

add pagination

This is a long pseudo list we can at least try to make it a bit more user-friendly

Add documentation

Short intro about the status of the project.
Contributor centric how-to
Dev centric documentation for maintenance

[Feature Request] Availability Info as proper links

The availability Information for each bibliographical item is currently a text line. Only a small number of items include actual html links, much less permalinks.

It would greatly enhance usability, as well as accountability if all items had proper links. DOI for secondary, permalinks for public domain library resources, etc.

link to matumi and locate mods records

also where did matumi's data go???

Create Basic webpage using Hugo

select and install theme, for searchable, CJK ready, light-dark mode selectable webpage

Link to heiData

once repo has been created there

add heienc-txt links

on readme and landing page

landing page

adjust author image
get pagination
be more explicit for links to main sections
mention heidENC more prominently

build issues with CI

MS_word to webpage

transform word to md split where appropriate

consider navigation

publish initial version based on May 14, 2019 docx file

configure CI

Setup CI, and modify contents for better web display

update info on BOA Seite

see https://www.zo.uni-heidelberg.de/boa/digital_resources/heidenc/