-
Notifications
You must be signed in to change notification settings - Fork 9
Feature/pretty docs with theme #413
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
Merged
Merged
Changes from all commits
Commits
Show all changes
43 commits
Select commit
Hold shift + click to select a range
43c85dd
Fix Docs
FBumann fa82b5f
Update Changelog and migration guide for missing breaking changes
FBumann a80da63
Update Migration guide
FBumann 344cf92
Improve
FBumann fbac191
Use tabs in mkdocs
FBumann ef35d90
Update varaibel renaming
FBumann 9f50ca2
Update variable renaming
FBumann cd3df05
From main
FBumann 9390fcd
Update
FBumann 0668042
Update
FBumann 4fb6a6c
Update
FBumann 8cced2a
Add links
FBumann cd87edf
Add emojis
FBumann 0d03660
compact 2
FBumann afb0d19
Enable plugin
FBumann 5cf023e
Update
FBumann e61aa02
Update
FBumann fc8288f
Customize
FBumann 3d83127
Customize
FBumann 7fb19dd
Add deps
FBumann 5b32627
Make index.md pretty
FBumann f0b0d54
Fix
FBumann c374c25
Fix
FBumann 23a6b5b
Fix icons
FBumann c1bc3f8
Fix quick nav
FBumann f730dfd
Use regular emojis
FBumann 1193b86
Update landing page
FBumann dcd6ead
Add semantic colors
FBumann 1a1f4a7
Add semantic colors
FBumann 31cf8c8
More css
FBumann 51cfdbf
Revert "More css"
FBumann a79e828
Revert "Add semantic colors"
FBumann d965143
Revert "Add semantic colors"
FBumann e6124ef
Merge remote-tracking branch 'origin/main' into feature/pretty-docs-w…
FBumann 53d49c6
Fix
FBumann 666aa64
Pin mkdocs
FBumann 0337d4d
Add rel="noopener noreferrer" to external links opened in new
FBumann 7629904
Remove duplication
FBumann 7e1c277
Change colors
FBumann a91372a
Change colors
FBumann 96a3407
Revert "Change colors"
FBumann 336e04d
Revert "Change colors"
FBumann db945f6
Add entry to CHANGELOG.md
FBumann File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,144 @@ | ||
| {% | ||
| include-markdown "../README.md" | ||
| %} | ||
|
|
||
| --- | ||
| title: Home | ||
| hide: | ||
| - navigation | ||
| - toc | ||
| --- | ||
|
|
||
| <div class="hero-section"> | ||
|
|
||
| <h1>flixOpt</h1> | ||
|
|
||
| <p class="tagline">Energy and Material Flow Optimization Framework</p> | ||
|
|
||
| <p>Model, optimize, and analyze complex energy systems with a powerful Python framework designed for flexibility and performance.</p> | ||
|
|
||
| <p class="hero-buttons"> | ||
| <a href="getting-started/" class="md-button md-button--primary">🚀 Get Started</a> | ||
| <a href="examples/" class="md-button">💡 View Examples</a> | ||
| <a href="https://github.com/flixOpt/flixopt" class="md-button" target="_blank" rel="noopener noreferrer">⭐ GitHub</a> | ||
| </p> | ||
|
|
||
| </div> | ||
|
|
||
| ## :material-map-marker-path: Quick Navigation | ||
|
|
||
| <div class="quick-links"> | ||
| <a href="getting-started/" class="quick-link-card"> | ||
| <h3>🚀 Getting Started</h3> | ||
| <p>New to FlixOpt? Start here with installation and your first model</p> | ||
| </a> | ||
|
|
||
| <a href="examples/" class="quick-link-card"> | ||
| <h3>💡 Examples Gallery</h3> | ||
| <p>Explore real-world examples from simple to complex systems</p> | ||
| </a> | ||
|
|
||
| ## Documentation Architecture | ||
| <a href="api-reference/" class="quick-link-card"> | ||
| <h3>📚 API Reference</h3> | ||
| <p>Detailed documentation of all classes, methods, and parameters</p> | ||
| </a> | ||
|
|
||
| <a href="user-guide/recipes/" class="quick-link-card"> | ||
| <h3>📖 Recipes</h3> | ||
| <p>Common patterns and best practices for modeling energy systems</p> | ||
| </a> | ||
|
|
||
| <a href="user-guide/mathematical-notation/" class="quick-link-card"> | ||
| <h3>∫ Mathematical Notation</h3> | ||
| <p>Understand the mathematical formulations behind the framework</p> | ||
| </a> | ||
|
|
||
| <a href="roadmap/" class="quick-link-card"> | ||
| <h3>🛣️ Roadmap</h3> | ||
| <p>See what's coming next and contribute to the future of FlixOpt</p> | ||
| </a> | ||
| </div> | ||
|
|
||
| ## 🏗️ Framework Architecture | ||
|
|
||
| <div class="architecture-section" markdown="1"> | ||
|
|
||
| <figure markdown> | ||
|  | ||
| <figcaption>Conceptual Usage and IO operations of FlixOpt</figcaption> | ||
| </figure> | ||
|
|
||
| **FlixOpt** provides a complete workflow for energy system optimization: | ||
|
|
||
| - **:material-file-code: Define** your system using Python components | ||
| - **:material-cog: Optimize** with powerful solvers (HiGHS, Gurobi, CPLEX) | ||
| - **:material-chart-box: Analyze** results with built-in visualization tools | ||
| - **:material-export: Export** to various formats for further analysis | ||
|
|
||
| </div> | ||
|
|
||
| ## :material-account-group: Community & Support | ||
|
|
||
| <div class="feature-grid" markdown="1"> | ||
|
|
||
| <div class="feature-card" markdown="1"> | ||
|
|
||
| :fontawesome-brands-github:{ .feature-icon } | ||
|
|
||
| ### GitHub | ||
|
|
||
| Report issues, request features, and contribute to the codebase | ||
|
|
||
| [Visit Repository →](https://github.com/flixOpt/flixopt){target="_blank" rel="noopener noreferrer"} | ||
|
|
||
| </div> | ||
|
|
||
| <div class="feature-card" markdown="1"> | ||
|
|
||
| :material-forum:{ .feature-icon } | ||
|
|
||
| ### Discussions | ||
|
|
||
| Ask questions and share your projects with the community | ||
|
|
||
| [Join Discussion →](https://github.com/flixOpt/flixopt/discussions){target="_blank" rel="noopener noreferrer"} | ||
|
|
||
| </div> | ||
|
|
||
| <div class="feature-card" markdown="1"> | ||
|
|
||
| :material-book-open-page-variant:{ .feature-icon } | ||
|
|
||
| ### Contributing | ||
|
|
||
| Help improve FlixOpt by contributing code, docs, or examples | ||
|
|
||
| [Learn How →](contribute/){target="_blank" rel="noopener noreferrer"} | ||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
| ## :material-file-document-edit: Recent Updates | ||
|
|
||
| !!! tip "What's New in v3.0.0" | ||
| Major improvements and breaking changes. Check the [Migration Guide](user-guide/migration-guide-v3.md) for upgrading from v2.x. | ||
|
|
||
| 📋 See the full [Release Notes](changelog/) for detailed version history. | ||
|
|
||
| --- | ||
|
|
||
| ## Next Steps | ||
| <div style="text-align: center; margin: 3rem 0; padding: 2rem; background: var(--md-code-bg-color); border-radius: 0.75rem;"> | ||
|
|
||
| <h3>Ready to optimize your energy system?</h3> | ||
|
|
||
| <p> | ||
| <a href="getting-started/" class="md-button md-button--primary md-button--lg">▶️ Start Building</a> | ||
| </p> | ||
|
|
||
| - **New to FlixOpt?** Start with the [Getting Started Guide](getting-started.md) | ||
| - **Want to see examples?** Check out the [Examples Gallery](examples/index.md) | ||
| - **Need API details?** Browse the [API Reference](api-reference/index.md) | ||
| - **Looking for advanced patterns?** See [Recipes](user-guide/recipes/index.md) | ||
| - **Curious about the future?** Read our [Roadmap](roadmap.md) | ||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| {% | ||
| include-markdown "../README.md" | ||
| start="## Installation" | ||
| end="## License" | ||
| %} | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Verify internal link targets exist.
Multiple relative links (getting-started/, examples/, api-reference/, user-guide/recipes/, user-guide/mathematical-notation/, roadmap/, contribute/, changelog/) should be verified to ensure they resolve correctly in the built site. Broken links will degrade the homepage experience.
Run the following script to check that link targets exist in the docs structure:
🏁 Script executed:
Length of output: 228
🏁 Script executed:
Length of output: 2403
🏁 Script executed:
Length of output: 1703
Create missing documentation pages for api-reference and changelog.
Verification confirms two broken links on the homepage:
api-reference/– link target does not exist in docschangelog/– link target does not exist in docsThese missing pages will result in 404 errors for users. Create
docs/api-reference/index.mdanddocs/changelog.md(or as directories with index.md) to resolve the broken links.🤖 Prompt for AI Agents