markata

Name	markata JSON
Version	0.9.0 JSON
	download
home_page	None
Summary	Static site generator plugins all the way down.
upload_time	2025-01-29 03:15:44
maintainer	None
docs_url	None
author	None
requires_python	>=3.6
license	MIT License Copyright (c) 2021-present Waylon S. Walker <waylon@waylonwalker.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 NONINFRINGEMENT. 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.
keywords	static-site
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <h1 align=center>
  <br>
  <a href="https://github.com/WaylonWalker/markata"><img src="https://user-images.githubusercontent.com/22648375/167527193-4e66d537-e78f-44dd-be65-2c1c109adf34.png" alt="Markata" width="400"></a>
</h1>

<p align=center>
  <em>
    Markdown to site, plugins all the way down
  </em>
</p>
 
A static site generator that will give you a great site with many standard web
features like rss, sitemaps, and seo tags, out of the box. Running `markata
build` will get you a that only requires you to write Markdown. If you have
additional features that you want, don't worry, since markata is built
completely on plugins you can develop and install your own plugins to add the
features you want.

> This has been a pet project for me to learn library development, plugin
> driven design, diskcache, and more.  It is the core of what builds my own site [waylonwalker.com](https://waylonwalker.com).

## UPCOMING NEXT RELEASE

The next release will be jinja filled. Out with all the single file templates, template strings, looping through card generation, we will have a proper jinja env with includes, bases, and all the things.  It will be much easier to maintain and render faster.


## Disclaimer

Make sure that you pin down what version of markata you want to use.  If you
are starting a new project that's probably the latest version from
[pypi](https://pypi.org/project/markata).  Things are likely to change in major
releases, I do my best to document them, and not to break patches.

## QuickStart

Markata is fully configurable through a `markata.toml` file, but the defaults
allow to build your site right out of the box with nothing more than Markdown.

### Installation

`markata` is hosted on pypi and can be installed using pip.

```bash
python -m pip install markata

# or if pipx is your thing

pipx install markata
```

### Building a Blog with Markata _using a template_

The markata cli includes a `new` command that will present you with questions
to fill in the jinja variables in this repo.

```bash
markata new blog [directory]

markata build
# start the site and watch for changes
markata serve
```

Now if you open localhost:8000, you will be presented with an example site that
will walk you through some features of markata. You can play with it at
your own pace, or drop all the pages and start writing your own content.

![new blog gif](./static/new-blog.gif)

## Motivation

Markata is able to build your site purely from Markdown, allowing you to get
started creating your own content quickly. Out of the box it will cover your
seo tags, rss feeds, sitemap, and og images. Since it is built completely from
plugins you can remove, modify, or add to any of its behavior.

- configurable
- plugins
- seo
- rss
- sitemap
- og-image

## Using Markata

The docs are still a work in progress, but the
[base_cli](https://markata.dev/markata/plugins/base_cli/) walks through how to
effectively use the `markata build` command. At this point Markata is far from
stable and **will change quite a bit**, should you choose to use it on real
site make sure you pin to the version that you want to build from. I will let
you know as it becomes more stable and ready to use without diligence of
pinning to the version you want.

**Honestly** A big motivation for me was wanting to learn and understand how to
create a project that is completely plugin driven. This is highly a learning
project for me, and it has grown into something I use every day.

## Examples Gallary

Markata has a project gallery to show off sites built with markata. Please
[submit](https://github.com/WaylonWalker/markata/issues/78) yours, and check
out the [project-gallery](http://markata.dev/project-gallery/) for inspiration.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "markata",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "static-site",
    "author": null,
    "author_email": "Waylon Walker <waylon@waylonwalker.com>, waylon@markata.dev",
    "download_url": "https://files.pythonhosted.org/packages/8d/0e/49fd2c633b899cc2efa6382a2293da20f92d0c7924e834cba000880e2a4e/markata-0.9.0.tar.gz",
    "platform": null,
    "description": "<h1 align=center>\n  <br>\n  <a href=\"https://github.com/WaylonWalker/markata\"><img src=\"https://user-images.githubusercontent.com/22648375/167527193-4e66d537-e78f-44dd-be65-2c1c109adf34.png\" alt=\"Markata\" width=\"400\"></a>\n</h1>\n\n<p align=center>\n  <em>\n    Markdown to site, plugins all the way down\n  </em>\n</p>\n \nA static site generator that will give you a great site with many standard web\nfeatures like rss, sitemaps, and seo tags, out of the box. Running `markata\nbuild` will get you a that only requires you to write Markdown. If you have\nadditional features that you want, don't worry, since markata is built\ncompletely on plugins you can develop and install your own plugins to add the\nfeatures you want.\n\n> This has been a pet project for me to learn library development, plugin\n> driven design, diskcache, and more.  It is the core of what builds my own site [waylonwalker.com](https://waylonwalker.com).\n\n## UPCOMING NEXT RELEASE\n\nThe next release will be jinja filled. Out with all the single file templates, template strings, looping through card generation, we will have a proper jinja env with includes, bases, and all the things.  It will be much easier to maintain and render faster.\n\n\n## Disclaimer\n\nMake sure that you pin down what version of markata you want to use.  If you\nare starting a new project that's probably the latest version from\n[pypi](https://pypi.org/project/markata).  Things are likely to change in major\nreleases, I do my best to document them, and not to break patches.\n\n## QuickStart\n\nMarkata is fully configurable through a `markata.toml` file, but the defaults\nallow to build your site right out of the box with nothing more than Markdown.\n\n### Installation\n\n`markata` is hosted on pypi and can be installed using pip.\n\n```bash\npython -m pip install markata\n\n# or if pipx is your thing\n\npipx install markata\n```\n\n### Building a Blog with Markata _using a template_\n\nThe markata cli includes a `new` command that will present you with questions\nto fill in the jinja variables in this repo.\n\n```bash\nmarkata new blog [directory]\n\nmarkata build\n# start the site and watch for changes\nmarkata serve\n```\n\nNow if you open localhost:8000, you will be presented with an example site that\nwill walk you through some features of markata. You can play with it at\nyour own pace, or drop all the pages and start writing your own content.\n\n![new blog gif](./static/new-blog.gif)\n\n## Motivation\n\nMarkata is able to build your site purely from Markdown, allowing you to get\nstarted creating your own content quickly. Out of the box it will cover your\nseo tags, rss feeds, sitemap, and og images. Since it is built completely from\nplugins you can remove, modify, or add to any of its behavior.\n\n- configurable\n- plugins\n- seo\n- rss\n- sitemap\n- og-image\n\n## Using Markata\n\nThe docs are still a work in progress, but the\n[base_cli](https://markata.dev/markata/plugins/base_cli/) walks through how to\neffectively use the `markata build` command. At this point Markata is far from\nstable and **will change quite a bit**, should you choose to use it on real\nsite make sure you pin to the version that you want to build from. I will let\nyou know as it becomes more stable and ready to use without diligence of\npinning to the version you want.\n\n**Honestly** A big motivation for me was wanting to learn and understand how to\ncreate a project that is completely plugin driven. This is highly a learning\nproject for me, and it has grown into something I use every day.\n\n## Examples Gallary\n\nMarkata has a project gallery to show off sites built with markata. Please\n[submit](https://github.com/WaylonWalker/markata/issues/78) yours, and check\nout the [project-gallery](http://markata.dev/project-gallery/) for inspiration.\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2021-present Waylon S. Walker <waylon@waylonwalker.com>\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy of\n        this software and associated documentation files (the \"Software\"), to deal in\n        the Software without restriction, including without limitation the rights to\n        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n        of the Software, and to permit persons to whom the Software is furnished to do\n        so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "Static site generator plugins all the way down.",
    "version": "0.9.0",
    "project_urls": {
        "Changelog": "https://markata.dev/CHANGELOG/",
        "Documentation": "https://markata.dev",
        "Homepage": "https://markata.dev",
        "Issues": "https://github.com/waylonwalker/markata/issues",
        "Source": "https://github.com/waylonwalker/markata"
    },
    "split_keywords": [
        "static-site"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "bff0fb6bdbd6ef544fe5c31fbf620d2c4d55e569f0deaa7f74dad982d6a1e596",
                "md5": "7ebe6e0f7e6b5bff1cd9d2fab1f392f2",
                "sha256": "762b39a075de22c4b9cdbda2bc4f8cbbd94a8bbebb7430fb7c2019c8e745ca50"
            },
            "downloads": -1,
            "filename": "markata-0.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7ebe6e0f7e6b5bff1cd9d2fab1f392f2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 166485,
            "upload_time": "2025-01-29T03:15:41",
            "upload_time_iso_8601": "2025-01-29T03:15:41.356538Z",
            "url": "https://files.pythonhosted.org/packages/bf/f0/fb6bdbd6ef544fe5c31fbf620d2c4d55e569f0deaa7f74dad982d6a1e596/markata-0.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8d0e49fd2c633b899cc2efa6382a2293da20f92d0c7924e834cba000880e2a4e",
                "md5": "45c63ef99e31acd9dd5d778d58734d35",
                "sha256": "d3f9610c4e1303eadbd83b200920a31a0d899986ad01d1d5c177c3db648a218b"
            },
            "downloads": -1,
            "filename": "markata-0.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "45c63ef99e31acd9dd5d778d58734d35",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 15874985,
            "upload_time": "2025-01-29T03:15:44",
            "upload_time_iso_8601": "2025-01-29T03:15:44.895590Z",
            "url": "https://files.pythonhosted.org/packages/8d/0e/49fd2c633b899cc2efa6382a2293da20f92d0c7924e834cba000880e2a4e/markata-0.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-29 03:15:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "waylonwalker",
    "github_project": "markata",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "markata"
}