Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add license to MkDocs #297

Open
AntonioMrtz opened this issue Jan 4, 2025 · 5 comments
Open

Add license to MkDocs #297

AntonioMrtz opened this issue Jan 4, 2025 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help-wanted Help is wanted python Pull requests that update Python code

Comments

@AntonioMrtz
Copy link
Owner

AntonioMrtz commented Jan 4, 2025

Description

Add copyright to MkDocs

Context

Copyright of the project was not shown on MkDocs

How to do it

Fill the field copyright on mkdocs.yml with our license. Docs can be found here

extra:
    copyright: |
      © 2025 [Antonio Martinez]. Licensed under a
      [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).

Testing

  • Check license is shown using mkdocs serve in a local environment

🖐️ Learn how to CONTRIBUTE, all help is welcomed :)

📚 Check out the project documentation for more info

⭐ Help this project grow by giving it a star if you like it!

😵 Trello links are used for traceability, do not ask to join the board before leaving a comment in the related issue

@AntonioMrtz AntonioMrtz added documentation Improvements or additions to documentation good first issue Good for newcomers help-wanted Help is wanted labels Jan 4, 2025
@AntonioMrtz
Copy link
Owner Author

MKdocs add license

@AntonioMrtz AntonioMrtz pinned this issue Feb 9, 2025
@AntonioMrtz AntonioMrtz added the python Pull requests that update Python code label Feb 9, 2025
@vihanvt
Copy link

vihanvt commented Mar 7, 2025

Hey! This is my first time contributing, just wanted to check if the only preferred approach is extra.copyright or adding it to root works.

@AntonioMrtz
Copy link
Owner Author

AntonioMrtz commented Mar 7, 2025

Hi @vihanvt nice to meet you. I was thinking about the extra.copyright approach but I'm open to other solutions. If you have other proposals feel free to show them here :).

@vihanvt
Copy link

vihanvt commented Mar 7, 2025

I tried adding the it directly at the root of the file:

site_url: https://antoniomrtz.github.io/SpotifyElectron_Web/docs # Website deployment URL
repo_url: https://github.com/AntonioMrtz/SpotifyElectron
site_description: Documentation for Spotify Electron, an open-source cross-platform music streaming app
remote_branch: gh-pages
copyright: © 2025 <a href="https://github.com/AntonioMrtz">Antonio Martinez</a>. Licensed under a <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.

for ref.

Image

@AntonioMrtz
Copy link
Owner Author

Looks good 👍

@AntonioMrtz AntonioMrtz unpinned this issue Mar 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help-wanted Help is wanted python Pull requests that update Python code
Projects
None yet
Development

No branches or pull requests

2 participants