Skip to content

Latest commit

 

History

History
561 lines (396 loc) · 18.1 KB

markdown.md

File metadata and controls

561 lines (396 loc) · 18.1 KB
icon
material/view-grid-plus

Markdown

Material for MkDocs offers a wide range of options for customizing your documentation. In this section, we will explain how you can create a meaningful structure for your site, change the look and feel, add a blog and comment system, and build a highly optimized site.

Site structure

Set up and customize the structure of your documentation by configuring the header and footer to your taste, choosing among many modes of navigation, setting up site search, and more.

  • :fontawesome-solid-earth-americas: Language – Choose out of the 60+ supported languages or add a new one
  • :material-page-layout-sidebar-left: Navigation – Create a clear, concise, and comprehensive navigation structure
  • :material-page-layout-header: Header – Customize the behavior of the header, add an announcement bar
  • :material-page-layout-footer: Footer – Add links to your social media profiles or websites in the footer
  • :material-tab-search: Search – Set up and configure search, running entirely in the user's browser
  • :material-tag-plus-outline: Tags – Categorize your pages with tags and group related pages

Appearance

Match your brand's colors, fonts, icons, logo, and more with a few lines of configuration – Material for MkDocs makes it easy to extend the basic configuration or alter the appearance.

  • :material-brush-variant: Colors Change colors with an existing color palette or customize with CSS
  • :material-format-font: Fonts – Choose among 1,000 Google Fonts or load self-hosted fonts
  • :material-google-downasaur: Logo & Icons – Change the logo, use any of the 8,000+ icons, or add new ones
  • :material-cards-variant: Social Cards – Automatically create social media previews when sharing links

Content

Create a blog, integrate a comment system, connect a git repository, and set up versioned documentation that matches your project's versioning methodology.

  • :material-book-open-outline: Blog – Set up a standalone blog or host it alongside your documentation
  • :material-comment-text-outline: Comment System – Add a third-party comment system on any page or footer
  • :octicons-versions-16: Versioning – Deploy multiple versions by integrating with external utilities
  • :octicons-repo-16: Repository – Connect your documentation to your git repository

Optimization

Add site analytics and build an optimized site by adding automatic image compression, complying with GDPR data privacy regulations, and making it offline-capable.

  • :material-google-analytics: Site analytics – Learn how your users experience your documentation
  • :material-screwdriver: Optimized site – Create optimized sites that rank great on search engines
  • :octicons-lock-16: Data Privacy – Ensure compliance with data privacy regulations
  • :octicons-cloud-offline-16: Offline usage – Build an online and offline-capable documentation

Subscribe to our newsletter{.md-button}

Goals

The following section lists all funding goals. Each goal contains a list of features prefixed with a checkmark symbol, denoting whether a feature is :octicons-check-circle-fill-24:{ style="color: #00e676" } already available or :octicons-check-circle-fill-24:{ style="color: var(--md-default-fg-color--lightest)" } planned, but not yet implemented. When the funding goal is hit, the features are released for general availability.

  • [Instant prefetching] :material-alert-decagram:{ .mdx-pulse title="Added on June 15, 2023" }
  • [Social plugin: custom layouts] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" }
  • [Social plugin: background images] :material-alert-decagram:{ .mdx-pulse title="Added on May 8, 2023" }
  • [Code range selection]
  • [Code annotations: custom selectors]
  • [Privacy plugin: optimization support]
  • [Optimize plugin]
  • [Navigation path] (Breadcrumbs)
  • [Typeset plugin]
  • [Privacy plugin: external links]
  • [Navigation subtitles]
  • [Tags plugin: allow list] + [custom sorting]
  • [Blog plugin: custom index pages]
  • [Blog plugin: related links]
  • Blog plugin
  • Navigation status
  • [Meta plugin]
  • [Tags plugin: additional indexes]
  • [Document contributors]
  • [Automatic light / dark mode]
  • [Content tabs: anchor links]
  • Navigation pruning
  • [Tooltips]
  • Chinese search support
  • Card grids
  • [Privacy plugin]
  • Annotations
  • Navigation icons

$ 12,000 – Piri Piri

Requirements

SysIdentPy requires:

Dependency version Comment
python >=3.7,<3.10
numpy >=1.9.2 for all numerical algorithms
scipy >=1.7.0 for some linear regression methods
matplotlib >=3.3.2 for static plotting and visualizations
torch >=1.7.1 Only necessary if you want to use Neural NARX models
Platform Status
Windows ok
Linux ok
Mac OS ok

SysIdentPy do not to support Python 2.7.

<script async src="https://platform.twitter.com/widgets.js"></script>

Important: If you're sponsoring @squidfunk through a GitHub organization, please send a short email to [email protected] with the name of your organization and the GitHub account of the individual that should be added as a collaborator.1

You can cancel your sponsorship anytime.2

Lacerda et al., (2020). SysIdentPy: A Python package for System Identification using NARMAX models. Journal of Open Source Software, 5(54), 2384, https://doi.org/10.21105/joss.02384

	@article{Lacerda2020,
	  doi = {10.21105/joss.02384},
	  url = {https://doi.org/10.21105/joss.02384},
	  year = {2020},
	  publisher = {The Open Journal},
	  volume = {5},
	  number = {54},
	  pages = {2384},
	  author = {Wilson Rocha Lacerda Junior and Luan Pascoal Costa da Andrade and Samuel Carlos Pessoa Oliveira and Samir Angelo Milani Martins},
	  title = {SysIdentPy: A Python package for System Identification using NARMAX models},
	  journal = {Journal of Open Source Software}
	}

Inspiration

The documentation and structure (even this section) is openly inspired by sklearn, einsteinpy, and many others as we used (and keep using) them to learn.

Contributors

Citation

If you use SysIdentPy on your project, please drop me a line.

[Send email :fontawesome-solid-paper-plane:](mailto: [email protected]){.md-button .md-button--primary }

<iframe src="https://streamable.com/e/yslhdu" allowfullscreen></iframe>

This documentation is built with Insiders [squidfunk.github.io/mkdocs-material][Material for MkDocs]

Grids

Material for MkDocs makes it easy to arrange sections into grids, grouping blocks that convey similar meaning or are of equal importance. Grids are just perfect for building index pages that show a brief overview of a large section of your documentation.

Configuration

This configuration enables the use of grids, allowing to bring blocks of identical or different types into a rectangular shape. Add the following lines to mkdocs.yml:

markdown_extensions: # (1)!
  - attr_list
  - md_in_html
  1. Note that some of the examples listed below use icons and emojis, which have to be configured separately.

See additional configuration options:

Usage

Grids come in two flavors: card grids, which wrap each element in a card that levitates on hover, and generic grids, which allow to arrange arbitrary block elements in a rectangular shape.

Using card grids

:octicons-heart-fill-24:{ .mdx-heart } Sponsors only{ .mdx-insiders } · :octicons-tag-24: insiders-4.12.0 · :octicons-beaker-24: Experimental

Card grids wrap each grid item with a beautiful hover card that levitates on hover. They come in two slightly different syntaxes: list and block syntax, adding support for distinct use cases.

List syntax

The list syntax is essentially a shortcut for card grids, and consists of an unordered (or ordered) list wrapped by a div with both, the grid and cards classes:

<div class="grid cards" markdown>

- :fontawesome-brands-html5: __HTML__ for content and structure
- :fontawesome-brands-js: __JavaScript__ for interactivity
- :fontawesome-brands-css3: __CSS__ for text running out of boxes
- :fontawesome-brands-internet-explorer: __Internet Explorer__ ... huh?

</div>

  • :fontawesome-brands-html5: HTML for content and structure

  • :fontawesome-brands-js: JavaScript for interactivity

  • :fontawesome-brands-css3: CSS for text running out of boxes

  • :fontawesome-brands-internet-explorer: Internet Explorer ... huh?

List elements can contain arbitrary Markdown, as long as the surrounding div defines the markdown attribute. Following is a more complex example, which includes icons and links:

<div class="grid cards" markdown>

-   :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__

    ---

    Install [`mkdocs-material`](#) with [`pip`](#) and get up
    and running in minutes
    
    [:octicons-arrow-right-24: Getting started](#)

-   :fontawesome-brands-markdown:{ .lg .middle } __It's just Markdown__

    ---

    Focus on your content and generate a responsive and searchable static site
    
    [:octicons-arrow-right-24: Reference](#)

-   :material-format-font:{ .lg .middle } __Made to measure__

    ---

    Change the colors, fonts, language, icons, logo and more with a few lines
    
    [:octicons-arrow-right-24: Customization](#)

-   :material-scale-balance:{ .lg .middle } __Open Source, MIT__

    ---

    Material for MkDocs is licensed under MIT and available on [GitHub]

    [:octicons-arrow-right-24: License](#)

</div>

If there's insufficient space to render grid items next to each other, the items will stretch to the full width of the viewport, e.g. on mobile viewports. If there's more space available, grids will render in items of 3 and more, e.g. when hiding both sidebars.

Block syntax

The block syntax allows for arranging cards in grids together with other elements, as explained in the section on generic grids. Just add the card class to any block element inside a grid:

<div class="grid" markdown>

:fontawesome-brands-html5: __HTML__ for content and structure
{ .card }

:fontawesome-brands-js: __JavaScript__ for interactivity
{ .card }

:fontawesome-brands-css3: __CSS__ for text running out of boxes
{ .card }

> :fontawesome-brands-internet-explorer: __Internet Explorer__ ... huh?

</div>

:fontawesome-brands-html5: HTML for content and structure { .card }

:fontawesome-brands-js: JavaScript for interactivity { .card }

:fontawesome-brands-css3: CSS for text running out of boxes { .card }

:fontawesome-brands-internet-explorer: Internet Explorer ... huh?

While this syntax may seem unnecessarily verbose at first, the previous example shows how card grids can now be mixed with other elements that will also stretch to the grid.

Using generic grids

:octicons-heart-fill-24:{ .mdx-heart } Sponsors only{ .mdx-insiders } · :octicons-tag-24: insiders-4.12.0 · :octicons-beaker-24: Experimental

Generic grids allow for arranging arbitrary block elements in a grid, including admonitions, code blocks, content tabs and more. Just wrap a set of blocks by using a div with the grid class:

<div class="grid" markdown>

=== "Unordered list"

    * Sed sagittis eleifend rutrum
    * Donec vitae suscipit est
    * Nulla tempor lobortis orci

=== "Ordered list"

    1. Sed sagittis eleifend rutrum
    2. Donec vitae suscipit est
    3. Nulla tempor lobortis orci

``` title="Content tabs"
=== "Unordered list"

    * Sed sagittis eleifend rutrum
    * Donec vitae suscipit est
    * Nulla tempor lobortis orci

=== "Ordered list"

    1. Sed sagittis eleifend rutrum
    2. Donec vitae suscipit est
    3. Nulla tempor lobortis orci
```

</div>

=== "Unordered list"

* Sed sagittis eleifend rutrum
* Donec vitae suscipit est
* Nulla tempor lobortis orci

=== "Ordered list"

1. Sed sagittis eleifend rutrum
2. Donec vitae suscipit est
3. Nulla tempor lobortis orci

=== "Unordered list"

    * Sed sagittis eleifend rutrum
    * Donec vitae suscipit est
    * Nulla tempor lobortis orci

=== "Ordered list"

    1. Sed sagittis eleifend rutrum
    2. Donec vitae suscipit est
    3. Nulla tempor lobortis orci

Footnotes

  1. It's currently not possible to grant access to each member of an organization, as GitHub only allows for adding users. Thus, after sponsoring, please send an email to [email protected], stating which account should become a collaborator of the Insiders repository. We're working on a solution which will make access to organizations much simpler. To ensure that access is not tied to a particular individual GitHub account, create a bot account (i.e. a GitHub account that is not tied to a specific individual), and use this account for the sponsoring. After being added to the list of collaborators, the bot account can create a private fork of the private Insiders GitHub repository, and grant access to all members of the organizations. ↩

  2. If you cancel your sponsorship, GitHub schedules a cancellation request which will become effective at the end of the billing cycle. This means that even though you cancel your sponsorship, you will keep your access to Insiders as long as your cancellation isn't effective. All charges are processed by GitHub through Stripe. As we don't receive any information regarding your payment, and GitHub doesn't offer refunds, sponsorships are non-refundable. ↩