Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found 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 (13.0%) to scientific vocabulary

Keywords

documentation github github-actions html markdown mkdocs model
Last synced: 4 months ago · JSON representation ·

Repository

笔记本

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 2
Topics
documentation github github-actions html markdown mkdocs model
Created about 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security Support

README.md

Material for MkDocs

A powerful documentation framework on top of MkDocs

Docker Stars GitHub License GitHub release Stars

Write your documentation in Markdown and create a professional static site for your Open Source or commercial project in minutes – searchable, customizable, more than 60 languages, for all devices.

MKdocs

note

Deploy

Deploy With Vercel(Recommended)

Deploy with Vercel

Just click the button above and follow the instructions to deploy your own copy of the app.

Deploy With Docker

To deploy with Docker, you can use the following command:

shell docker run -d --name mkdocs -p 80:8000 miniwater/mkdocs:latest

or

shell docker run -d --name mkdocs \ --restart always \ -p 80:8000 \ miniwater/mkdocs:latest

This will start the geminiprochat service, accessible at http://localhost:80.

Contributing

Contributions of all types are more than welcome; if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] and [Projects][github-project-link] to get stuck in to show us what you’re made of.

Star History

Star History Chart

FOSSA Status

FOSSA Status

License

MIT License

Copyright (c) 2014-2023 手里有只毛毛虫, All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Owner

  • Name: miniwater
  • Login: miniwater
  • Kind: user

没有

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Mini"
  given-names: "Water"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2023-12-18
url: "https://github.com/miniwater/mkdocs"

GitHub Events

Total
Last Year

Dependencies

.github/workflows/Issue.yml actions
  • actions-cool/issues-helper main composite
.github/workflows/ci.yml actions
  • actions/cache v3 composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • docker/build-push-action v5 composite
  • docker/login-action v3 composite
  • docker/metadata-action v5 composite
  • softprops/action-gh-release v1 composite
Dockerfile docker
  • python 3.11-alpine3.18 build
requirements.txt pypi
  • mkdocs-material *