Commit df441033 authored by Alexander Martinez's avatar Alexander Martinez
Browse files

template

parent 24f647d5
Pipeline #1182 failed with stages
in 1 minute and 45 seconds
This diff is collapsed.
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at
https://gitter.im/squidfunk/mkdocs-material. The project team will review and
investigate all complaints, and will respond in a way that it deems appropriate
to the circumstances. The project team is obligated to maintain confidentiality
with regard to the reporter of an incident. Further details of specific
enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
# Contributing Guide
# Contributing
Interested in contributing to the Material for MkDocs? Want to report a bug?
Have a question? Before you do, please read the following guidelines.
## Submission context
### Got a question or problem?
For quick questions there's no need to open an issue as you can reach us on
[gitter.im][1].
[1]: https://gitter.im/squidfunk/mkdocs-material
### Found a bug?
If you found a bug in the source code, you can help us by submitting an issue
to the [issue tracker][2] in our GitHub repository. Even better, you can submit
a Pull Request with a fix. However, before doing so, please read the
[submission guidelines][3].
[2]: https://github.com/squidfunk/mkdocs-material/issues
[3]: #submission-guidelines
### Missing a feature?
You can request a new feature by submitting an issue to our GitHub Repository.
If you would like to implement a new feature, please submit an issue with a
proposal for your work first, to be sure that it is of use for everyone, as
Material for MkDocs is highly opinionated. Please consider what kind of change
it is:
* For a **major feature**, first open an issue and outline your proposal so
that it can be discussed. This will also allow us to better coordinate our
efforts, prevent duplication of work, and help you to craft the change so
that it is successfully accepted into the project.
* **Small features and bugs** can be crafted and directly submitted as a Pull
Request. However, there is no guarantee that your feature will make it into
the `master`, as it's always a matter of opinion whether if benefits the
overall functionality of the project.
## Submission guidelines
### Submitting an issue
Before you submit an issue, please search the issue tracker, maybe an issue for
your problem already exists and the discussion might inform you of workarounds
readily available.
We want to fix all the issues as soon as possible, but before fixing a bug we
need to reproduce and confirm it. In order to reproduce bugs we will
systematically ask you to provide a minimal reproduction scenario using the
custom issue template. Please stick to the issue template.
Unfortunately we are not able to investigate / fix bugs without a minimal
reproduction scenario, so if we don't hear back from you we may close the issue.
### Submitting a Pull Request (PR)
Search GitHub for an open or closed PR that relates to your submission. You
don't want to duplicate effort. If you do not find a related issue or PR,
go ahead.
1. **Development**: Fork the project, set up the [development environment][4],
make your changes in a separate git branch and add descriptive messages to
your commits.
2. **Build**: Before submitting a pull requests, [build the theme][5]. This is
a mandatory requirement for your PR to get accepted, as the theme should at
all times be installable through GitHub.
3. **Pull Request**: After building the theme, commit the compiled output, push
your branch to GitHub and send a PR to `mkdocs-material:master`. If we
suggest changes, make the required updates, rebase your branch and push the
changes to your GitHub repository, which will automatically update your PR.
After your PR is merged, you can safely delete your branch and pull the changes
from the main (upstream) repository.
[4]: https://squidfunk.github.io/mkdocs-material/customization/#environment-setup
[5]: https://squidfunk.github.io/mkdocs-material/customization/#build-process
# Copyright (c) 2016-2021 Martin Donath <martin.donath@squidfunk.com>
# 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 NON-INFRINGEMENT. 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.
FROM python:3.9.2-alpine3.13
# Build-time flags
ARG WITH_PLUGINS=true
# Environment variables
ENV PACKAGES=/usr/local/lib/python3.9/site-packages
ENV PYTHONDONTWRITEBYTECODE=1
# Set build directory
WORKDIR /tmp
# Copy files necessary for build
COPY material material
COPY MANIFEST.in MANIFEST.in
COPY package.json package.json
COPY README.md README.md
COPY requirements.txt requirements.txt
COPY setup.py setup.py
# Perform build and cleanup artifacts and caches
RUN \
apk upgrade --update-cache -a && \
apk add --no-cache \
git \
git-fast-import \
openssh \
&& apk add --no-cache --virtual .build gcc musl-dev \
&& pip install --no-cache-dir . \
&& \
if [ "${WITH_PLUGINS}" = "true" ]; then \
pip install --no-cache-dir \
"mkdocs-minify-plugin>=0.3" \
"mkdocs-redirects>=1.0"; \
fi \
&& apk del .build gcc musl-dev \
&& \
for theme in mkdocs readthedocs; do \
rm -rf ${PACKAGES}/mkdocs/themes/$theme; \
ln -s \
${PACKAGES}/material \
${PACKAGES}/mkdocs/themes/$theme; \
done \
&& rm -rf /tmp/* /root/.cache \
&& \
find ${PACKAGES} \
-type f \
-path "*/__pycache__/*" \
-exec rm -f {} \;
# Set working directory
WORKDIR /docs
# Expose MkDocs development server port
EXPOSE 8000
# Start development server by default
ENTRYPOINT ["mkdocs"]
CMD ["serve", "--dev-addr=0.0.0.0:8000"]
This diff is collapsed.
recursive-include material *.js *.css *.map *.html *.svg *.png *.yml
recursive-include material *.ttf *.woff *.woff2 LICENSE*
recursive-exclude material/overrides *
recursive-exclude site *
recursive-exclude src *
recursive-exclude * __pycache__
recursive-exclude * *.py[co]
include LICENSE
include package.json
include README.md
include requirements.txt
# Racimo Tormena Docs
<p align="center">
<a href="https://squidfunk.github.io/mkdocs-material/">
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.svg" width="320" alt="Material for MkDocs">
</a>
</p>
Código fuente para la pagina web-documentación del proyecto Racimo Tormenta
\ No newline at end of file
<p align="center">
<strong>
A
<a href="https://material.io/">Material Design</a>
theme for
<a href="https://www.mkdocs.org/">MkDocs</a>
</strong>
</p>
<p align="center">
<a href="https://github.com/squidfunk/mkdocs-material/actions"><img
src="https://github.com/squidfunk/mkdocs-material/workflows/build/badge.svg?branch=master"
alt="Build"
/></a>
<a href="https://pypistats.org/packages/mkdocs-material"><img
src="https://img.shields.io/pypi/dm/mkdocs-material.svg"
alt="Downloads"
/></a>
<a href="https://gitter.im/squidfunk/mkdocs-material"><img
src="https://badges.gitter.im/squidfunk/mkdocs-material.svg"
alt="Chat on Gitter"
/></a>
<a href="https://pypi.org/project/mkdocs-material"><img
src="https://img.shields.io/pypi/v/mkdocs-material.svg"
alt="Python Package Index"
/></a>
<a href="https://hub.docker.com/r/squidfunk/mkdocs-material/"><img
src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material"
alt="Docker Pulls"
/></a>
<a href="https://squidfunk.github.io/mkdocs-material/insiders/"><img
src="https://img.shields.io/static/v1?label=%E2%86%92&message=insiders&color=e91e63"
/></a>
</p>
<p align="center">
Create a branded static site from a set of Markdown files to host the
documentation of your Open Source or commercial project – customizable,
searchable, mobile-friendly, 40+ languages. Set up in 5 minutes.
</p>
<p align="center">
<a href="https://squidfunk.github.io/mkdocs-material/getting-started/">
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/screenshot.png" width="700" />
</a>
</p>
<p align="center">
<em>
A demo is worth a thousand words — check it out at
<a
href="https://squidfunk.github.io/mkdocs-material/"
>squidfunk.github.io/mkdocs-material</a>.
</em>
</p>
## Features
* **It's just Markdown ...** — write your technical documentation in Markdown –
no need to know HTML, JavaScript or CSS. Material for MkDocs will do the heavy
lifting and create a beautiful and functional website.
* **... but there's more** — integrates natively with Python Markdown
Extensions, adding callouts, tabbed content containers, mathematical formulas,
critic markup, task lists, and [more than 10k icons and emojis][2].
* **Responsive by design** — built from the ground up to work on all kinds of
devices – from mobile phones to widescreens. The underlying fluid layout will
always adapt perfectly to the available screen space.
* **Static, but searchable** — almost magically, your technical documentation
website will be searchable without any further ado. Material for MkDocs comes
with built-in search – no server needed.
* **Many configuration options** — change the color palette, font families,
language, icons, favicon and logo. Add a source repository link, links to your
social profiles, Google Analytics and Disqus - all with a few lines of config.
* **Truly international** — thanks to many contributors, Material for MkDocs
includes translations for more than 40 languages and offers full native RTL
(right-to-left) support.
* **Accessible** — Material for MkDocs provides extensible keyboard navigation
and semantic markup including role attributes and landmarks. Furthermore, the
layout respects the user's default font size.
* **Modern architecture** — Material for MkDocs's underlying codebase is built
on top of TypeScript, RxJS, and SCSS, bringing excellent possibilities for
theme extension and customization.
_Material for MkDocs uses the [sponsorware][3] release strategy, which means
that new features are first exclusively released to sponsors as part of Material
for MkDocs Insiders. Read on to learn [how sponsorship works][4], and how you
can [become a sponsor][5]._
[2]: https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#search
[3]: https://github.com/sponsorware/docs
[4]: https://squidfunk.github.io/mkdocs-material/insiders/#how-sponsorship-works
[5]: https://squidfunk.github.io/mkdocs-material/insiders/#how-to-become-a-sponsor
## Quick start
Material for MkDocs can be installed with `pip`:
``` sh
pip install mkdocs-material
```
Add the following line to `mkdocs.yml`:
``` yaml
theme:
name: material
```
For other installation methods, configuration options, and a demo, visit
[squidfunk.github.io/mkdocs-material][1]
[1]: https://squidfunk.github.io/mkdocs-material/
## Premium Sponsors
<p>
<a href="https://docs.baslerweb.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/basler.png" width="155"
/></a>
<a href="https://cirrus-ci.org/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/cirrus-ci.svg" width="155"
/></a>
</p>
## Trusted by ...
### ... leading companies
[AWS](https://aws.github.io/copilot-cli/),
[Binance](https://docs.binance.org/),
[Datadog](https://datadoghq.dev/integrations-core/),
[Google](https://google.github.io/xls/),
[ING](https://ing-bank.github.io/baker/),
[LinkedIn](https://linkedin.github.io/school-of-sre/),
[Microsoft](https://microsoft.github.io/code-with-engineering-playbook/),
[Netflix](https://netflix.github.io/titus/),
[Salesforce](https://policy-sentry.readthedocs.io/en/latest/),
[SoundCloud](https://intervene.dev/),
[Square](https://square.github.io/okhttp/),
[Zalando](https://opensource.zalando.com/skipper/)
### ... and successful Open Source projects
[AutoKeras](https://autokeras.com/),
[BFE](https://www.bfe-networks.net/),
[Crystal](https://crystal-lang.org/reference/),
[FastAPI](https://fastapi.tiangolo.com/),
[Kubernetes](https://kops.sigs.k8s.io/),
[kSQL](https://docs.ksqldb.io/),
[Nokogiri](https://nokogiri.org/),
[OpenFaaS](https://docs.openfaas.com/),
[Pi-Hole](https://docs.pi-hole.net/),
[Pydantic](https://pydantic-docs.helpmanual.io/),
[Renovatebot](https://docs.renovatebot.com/),
[Traefik](https://docs.traefik.io/),
[Vapor](https://docs.vapor.codes/),
[ZeroNet](https://zeronet.io/docs/),
[WTF](https://wtfutil.com/)
## License
**MIT License**
Copyright (c) 2016-2021 Martin Donath
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 NON-INFRINGEMENT. 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.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment