Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/attpc/homepage

The homepage for the AT-TPC written using MkDocs

https://github.com/attpc/homepage

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 (11.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

The homepage for the AT-TPC written using MkDocs

Basic Info
  • Host: GitHub
  • Owner: ATTPC
  • License: mit
  • Default Branch: main
  • Size: 34.4 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed about 1 year ago
Metadata Files
Readme Contributing License

README.md

homepage

The homepage for the AT-TPC written using MkDocs

Requirements

Python 3.8+

Download and Install Dependencies

To setup this repository, first download it from GitHub using

bash git clone https://github.com/ATTPC/homepage.git -b your_dev

where your_dev should be replaced with the name of your specific development branch. Then, from within your repository, create a virtual environment using

bash python -m venv .venv

You may need to replace python with a specific version such as python3 or python3.11. Then activate your environment using

bash source .venv/bin/activate

Finally, install the dependencies using pip

bash pip install -r requirements.txt

Note: these instructions are for MacOS and Linux. Windows instructions are similar, but the commands will be slightly different.

Run the website locally

To run a test of the website use the following command from the root of the repository

bash mkdocs serve

This will build and serve the website on localhost. MkDocs will watch for changes in the repo and update the site when files are changed.

How to edit

Simply modify the existing MarkDown files in docs or add new ones! When adding a new file be sure to add it to the nav section of the mkdocs.yml file in the root of the repository.

Deploying (Admin Only)

Clone both this repository and the Pages repo. From the Pages repo run the following command:

bash mkdocs gh-deploy --config-file <path_to_homepage>/mkdocs.yml --remote-branch master

Replace <path_to_homepage> with the path to this repository from the Pages repo.

Owner

  • Name: AT-TPC Group
  • Login: ATTPC
  • Kind: organization

GitHub Events

Total
  • Push event: 18
  • Pull request review event: 1
  • Pull request event: 11
Last Year
  • Push event: 18
  • Pull request review event: 1
  • Pull request event: 11

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 1 hour
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • gwm17 (11)
  • DBazin (3)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

requirements.txt pypi
  • Jinja2 ==3.1.4
  • Markdown ==3.7
  • MarkupSafe ==2.1.5
  • PyYAML ==6.0.2
  • Pygments ==2.18.0
  • babel ==2.16.0
  • certifi ==2024.8.30
  • charset-normalizer ==3.3.2
  • click ==8.1.7
  • colorama ==0.4.6
  • ghp-import ==2.1.0
  • idna ==3.10
  • mergedeep ==1.3.4
  • mkdocs ==1.6.1
  • mkdocs-get-deps ==0.2.0
  • mkdocs-material ==9.5.36
  • mkdocs-material-extensions ==1.3.1
  • packaging ==24.1
  • paginate ==0.5.7
  • pathspec ==0.12.1
  • platformdirs ==4.3.6
  • pymdown-extensions ==10.10.1
  • python-dateutil ==2.9.0.post0
  • pyyaml_env_tag ==0.1
  • regex ==2024.9.11
  • requests ==2.32.3
  • six ==1.16.0
  • urllib3 ==2.2.3
  • watchdog ==5.0.2