From 6cf6ff4f42760ff4c598883feb4611065841ba3e Mon Sep 17 00:00:00 2001 From: Julio Cesar Contreras Huerta <126512018+JulioContrerasH@users.noreply.github.com> Date: Sun, 8 Sep 2024 20:23:50 +0200 Subject: [PATCH] up --- CHANGELOG.md | 44 +++++++++++++++++++++---------------------- CONTRIBUTING.md | 8 ++++---- README.md | 2 +- docs/js/copybutton.js | 18 ++++++++++++++++++ docs/style/style.css | 30 +++++++++++++++++++++++++++++ mkdocs.yml | 36 +++++++++-------------------------- 6 files changed, 83 insertions(+), 55 deletions(-) create mode 100644 docs/js/copybutton.js create mode 100644 docs/style/style.css diff --git a/CHANGELOG.md b/CHANGELOG.md index 33adc2c..861e72d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,34 +1,32 @@ -# Changelog +# **Changelog** All notable changes to this project will be documented in this file. The format is based on [Keep a changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## **[Unreleased]** -### Added ✨ -- Documentation updates and additional examples for alignment methods. 📚 +### **Added** +- Documentation updates and additional examples for alignment methods. -### Changed 🛠️ -- Enhanced performance optimizations in co-registration methods. 🚀 +### **Changed** +- Enhanced performance optimizations in co-registration methods. -### Fixed 🐛 -- Minor bug fixes in spatial alignment functions. 🔧 +### **Fixed** +- Minor bug fixes in spatial alignment functions. -## [0.1.3] - 2024-05-25 -### Added ✨ -- New methods for spatial alignment of satellite imagery. 🛰️ -- Expanded documentation with examples and usage guides. 📄 +## **[0.1.3] - 2024-05-25** +### **Added** +- New methods for spatial alignment of satellite imagery. +- Expanded documentation with examples and usage guides. -## [0.1.1] - 2024-05-12 -### Added ✨ -- Initial release of Satalign with basic functionalities for image co-registration. 🛠️ -- Examples demonstrating the use of PCC, ECC, and LGM alignment methods. 📊 +## **[0.1.1] - 2024-05-12** +### Added +- Initial release of Satalign with basic functionalities for image co-registration. +- Examples demonstrating the use of PCC, ECC, and LGM alignment methods. -## [0.1.0] - 2024-05-08 -### Added ✨ -- Basic structure for Satalign. 🏗️ -- Set up CI/CD pipeline with GitHub Actions. ⚙️ -- Added basic tests and coverage reports. ✅ - ---- \ No newline at end of file +## **[0.1.0] - 2024-05-08** +### **Added** +- Basic structure for Satalign. +- Set up CI/CD pipeline with GitHub Actions. +- Added basic tests and coverage reports. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c8fed2..6c227be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,11 +4,11 @@ We welcome contributions from the community! Every contribution, no matter how s ## **How to contribute** 🛠️ -1. **Fork the repository:** Start by forking the [Satalign](https://github.com/IPL-UV/Satalign) repository to your GitHub account. 🍴 +1. **Fork the repository:** Start by forking the [Satalign](https://github.com/IPL-UV/satalign) repository to your GitHub account. 🍴 2. **Clone your fork locally:** ```bash cd - git clone https://github.com/YOUR_GITHUB_USERNAME/Satalign.git + git clone https://github.com/IPL-UV/satalign.git cd Satalign ``` 3. **Create a branch:** Create a new branch for your feature or bug fix: @@ -51,9 +51,9 @@ We welcome contributions from the community! Every contribution, no matter how s ## **Types of contributions** 📦 - **Report bugs:** 🐛 - - Report bugs by creating an issue on the [Satalign GitHub repository](https://github.com/IPL-UV/Satalign/issues). Please include your operating system, setup details, and steps to reproduce the bug. + - Report bugs by creating an issue on the [Satalign GitHub repository](https://github.com/IPL-UV/satalign/issues). Please include your operating system, setup details, and steps to reproduce the bug. - **Fix bugs:** 🛠️ Look for issues tagged with "bug" and "help wanted" in the repository to start fixing. - **Implement features:** ✨ Contribute by implementing features tagged with "enhancement" and "help wanted." - **Write documentation:** 📚 Contribute to the documentation in the official docs, docstrings, or through blog posts and articles. - **Submit feedback:** 💬 Propose new features or give feedback by filing an issue on GitHub. - - Use the [Satalign GitHub issues page](https://github.com/IPL-UV/Satalign/issues) for feedback. \ No newline at end of file + - Use the [Satalign GitHub issues page](https://github.com/IPL-UV/satalign/issues) for feedback. \ No newline at end of file diff --git a/README.md b/README.md index 3bc5ea8..8109a4e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ #

- +

diff --git a/docs/js/copybutton.js b/docs/js/copybutton.js new file mode 100644 index 0000000..d66a9ab --- /dev/null +++ b/docs/js/copybutton.js @@ -0,0 +1,18 @@ +document.addEventListener('DOMContentLoaded', function() { + let blocks = document.querySelectorAll('pre code'); + blocks.forEach((block) => { + let button = document.createElement('button'); + button.innerHTML = 'Copy'; + button.classList.add('copy-button'); + block.parentNode.appendChild(button); + button.addEventListener('click', () => { + let range = document.createRange(); + range.selectNode(block); + window.getSelection().addRange(range); + document.execCommand('copy'); + window.getSelection().removeAllRanges(); + button.innerHTML = 'Copied!'; + setTimeout(() => { button.innerHTML = 'Copy'; }, 2000); + }); + }); +}); diff --git a/docs/style/style.css b/docs/style/style.css new file mode 100644 index 0000000..60e1d18 --- /dev/null +++ b/docs/style/style.css @@ -0,0 +1,30 @@ +/* bottom copy */ +.copy-button { + position: absolute; + right: 0; + top: 0; + padding: 5px 10px; + font-size: 12px; + background: #333; + color: white; + border: none; + cursor: pointer; +} + +.copy-button:hover { + background: #555; +} + +/* nav */ +.md-tabs__list { + display: flex; + justify-content: space-evenly; +} + +[data-md-color-primary=black] .md-header { + background-color: #596346; +} + +[data-md-color-primary=black] .md-tabs { + background-color: #1a2d5d; +} diff --git a/mkdocs.yml b/mkdocs.yml index 088b972..92d6fb4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -48,32 +48,6 @@ nav: - Contributing: CONTRIBUTING.md - Changelog: CHANGELOG.md - Code of conduct: CODE_OF_CONDUCT.md - # - Tasks: - # - ./mlstac/collection/tasks/README.md - # - Remote Sensing: - # - Tensor Classification: ./mlstac/collection/tasks/TensorClassification.md - # - Tensor Regression: ./mlstac/collection/tasks/TensorRegression.md - # - Tensor Object Detection: ./mlstac/collection/tasks/TensorObjectDetection.md - # - Tensor Segmentation: ./mlstac/collection/tasks/TensorSegmentation.md - # - Tensor to Tensor: ./mlstac/collection/tasks/TensorToTensor.md - - # - Multimodal: - # - Tensor to Text: ./mlstac/collection/tasks/TensorToText.md - # - Text to Tensor: ./mlstac/collection/tasks/TextToTensor.md - # - Sample: - # - ./mlstac/sample/README.md - # - Specification: ./mlstac/sample/specification.md - # - Safetensor: ./mlstac/sample/safetensor.md - # - Schema: ./mlstac/sample/squema.md - # # - Catalog: - # # - ./mlstac/catalog/README.md - # # - Specification: ./mlstac/catalog/specification.md - # # - Squema: ./mlstac/catalog/squema.md - # - Collection: - # - ./mlstac/collection/README.md - # - Specification: ./mlstac/collection/specification.md - # - Schema: ./mlstac/collection/squema.md - # - API: ./mlstac/api/README.md # Plugins plugins: @@ -90,4 +64,12 @@ markdown_extensions: - pymdownx.pathconverter - pymdownx.tabbed - mdx_truly_sane_lists - - pymdownx.tasklist \ No newline at end of file + - pymdownx.tasklist + +# Extra CSS +extra_css: + - docs/style/style.css + +# Extra JavaScript +extra_javascript: + - docs/js/copybutton.js