escriptorium-documentation
Source code to eScriptorium Documentation's website (powered with Mkdocs)
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.1%) to scientific vocabulary
Keywords
Repository
Source code to eScriptorium Documentation's website (powered with Mkdocs)
Basic Info
- Host: GitHub
- Owner: alix-tz
- License: mit
- Default Branch: main
- Homepage: https://escriptorium.readthedocs.io
- Size: 178 MB
Statistics
- Stars: 12
- Watchers: 1
- Forks: 10
- Open Issues: 15
- Releases: 0
Topics
Metadata Files
README.md
This GitHub repository stores the source code for the eScriptorium documentation. It is a collective initiative, open to anyone and designed to be modified by anyone.
The eScriptorium Documentation website is powered by MkDocs and hosted on readthedocs. All the source files of the pages are written in Markdown, which is a light markup language facilitating future editions.
For more information on Markdown's syntax, see the cheat-sheet.
Contribute
Anyone can contribute to this project by:
- listing errors in a dedicated issue, preferably offering solutions;
- editing the files (see below) and opening pull requests, preferably justifying the necessity of the edition;
- picking up tasks from the issues board, in particular those tagged with "help wanted".
Editions can be minor (you spot a missing s, a broken link, etc) or major (a piece of information is out-dated, you want to add a whole new page, etc). Any reasonable modification is welcome, as long as it helps keep this documentation up-to-date with the core eScriptorium application.
Edit the files and run a local test server
The following steps will allow you to locally test the success of the website's build before pushing your modifications to the project.
- Clone this repository and move to the corresponding directory
sh
git clone git@github.com:alix-tz/escriptorium-documentation.git
cd escriptorium-tutorial/
- Create your own local branch
sh
git checkout -b my-new-branch
- Create a Python 3.8 virtual environment and install mkdocs from requirements
(with conda)
sh
conda -n create venv python=3.8
pip install -r requirements.txt
- Start the dev server
sh
mkdocs serve
Open up http://127.0.0.1:8000/ in your browser to see the default home page.
Note that the local server will automatically reload the content when you save a document.
For more information on how to install and use mkdocs, see the official documentation.
Owner
- Name: Alix Chagué
- Login: alix-tz
- Kind: user
- Company: Inria
- Website: http://alix-tz.github.io
- Twitter: Alix_Tz
- Repositories: 10
- Profile: https://github.com/alix-tz
PhD student in Digital Humanities @ Université de Montréal and Inria.
GitHub Events
Total
- Issues event: 3
- Watch event: 2
- Issue comment event: 3
- Push event: 1
- Pull request event: 3
- Fork event: 11
Last Year
- Issues event: 3
- Watch event: 2
- Issue comment event: 3
- Push event: 1
- Pull request event: 3
- Fork event: 11
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 2
- Total pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 4 days
- Total issue authors: 2
- Total pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.5
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 4 days
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 0.5
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- alix-tz (4)
- Larry3460 (1)
- ssp24 (1)
Pull Request Authors
- alix-tz (2)
- Larry3460 (1)
- stweil (1)
- pastokes (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- mkdocs ==1.4.2
- mkdocs-material ==9.0.9