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

Edit on GitHub #21

Closed
WaylonWalker opened this issue Feb 16, 2022 · 0 comments · Fixed by #34 or #35
Closed

Edit on GitHub #21

WaylonWalker opened this issue Feb 16, 2022 · 0 comments · Fixed by #34 or #35

Comments

@WaylonWalker
Copy link
Owner

It would be nice to have a edit on github plugin/link.

WaylonWalker added a commit that referenced this issue May 23, 2022
WaylonWalker added a commit that referenced this issue May 23, 2022
WaylonWalker added a commit that referenced this issue May 23, 2022
* fix mypy issues

* fix pyinstument overrides callback (#6)

resolves #5 

* fix: pyinstument plugin no longer overrides the main cli callback
* feat: default is to run the profiler if pyinstrument is installed
* fix: --profile is now under the build command

## New cli help

After the pyinstrument plugin was fixed --version and  --to-json are back, and --profile is now under the build command.

![image](https://user-images.githubusercontent.com/22648375/150662983-547aebbd-c18c-4c17-8985-a6dc01cd29c7.png)

* implement --pretty/--no-pretty

* docs: add pretty to CHANGELOG

* add to CHANGELOG

* document base_cli

* remove unused console function

* disable cache for now

* update build command

* update docs

* link to base_cli on home page

* deprecate article['content_hash']

* add to the readme

* access content with .content, not ['content']

* add link to github

* fixed invalid syntax in fstring (#8)

* note which page/filter are causeing issue

* init tests

* run tests in ci

* fix flake8 issue

* remove renamed file

* fix link

* add page about home-page

* create heading-link plugin

* add simple docs to heading_link

* link home-page on index

* Bump version: 0.0.1 → 0.1.0

* update changelog before release

* check markata directory

* update gallary of sites

* bust cache on plugin change

* rework long_description plugin into auto_description

* swap long_description for auto_description

* fix whitespace

* fix covers plugin

* correct the hash key

* set long_description in auto_description automatically

* wip feeds

* fix whitespace

* fix not in issue

* continue docs

* monospace all the things

* make headings stand out

* fix auto_description key

* implement clean

* update CHANGELOG

* only store what's needed in cache

* add plugin text and config to the cache key

* reduce complexity for flake8

* Themable dark light mode (#29)

* dump config to jinja

* feat: ability to map entire posts

* fix spacing from Tyler Potts review

* add theme toggle

* run tidy html on template

* format script tag

* don't fail build on missing jinja variables

* fix: publish_source will now ignore non yaml serializable values

* doc: add publish_source fix to changelog

* update changelog

* wip jinja_md

* create prevnext plugin

* ignore jinja_md during jinja_md

* fix dark theme switching

* make jinja_md a default

* fix typo extra _

* fix prevnext index broken

* circle through feeds one feed at a time

* add prevnext config for the docs

* remove unused imports

* fix trailing whitespace

* clean up unused code

* create strategy to cycle through first or all posts in prevnext

* docs for prevnext

* fix: dedupe auto_descriptions

* fix: join paragraph literals

* fix typo

* document the configuration for covers

* add docs for publish source plugin

* docs changelog

* its called prevnext

* flex-direction for prevnext

* fix deepcopy recursion in publish source plugins

* fix prevnext style for longer descriptions

* formatting css

* remove unused imports

* raise error on unsupported prevnext strategy

* fix NotImplementedError

* added edit link default frontmatter (#32)

* New readme (#30)

* Update README.md

* Update README.md

* add another logo option

* add color logo option

* add new favicon

* wip readme

* Add techtructive blog

* add pype.dev

* clean up commented code

* don't mutate when not necessary

* don't heading link titles

* add edit link to docs

* add edit button to post template

* configure repo

* change some color defaults

* inherit colors from global colors if prevnext colors are not configured

* document colors

* type hint prevnext

* make prevnext config a list

* A11Y make sure links have alt and title

* modify config during config phase

* add reverse and sort on date if date is in name

* also sort on datetime if datetime is in the name

* config during configure phase

* docs changelog

* docs: update changelog

* include CHANGELOG as a page

* remove unused feeds_config

* send the message to the error

* just get the config from markata.config

* add 404 page

* document the flat_slug plugin

* replace try except with .get

* document publish_html

* allow explicitly set output_html

* explicitly set the output_html for the 404 page

* update readme

* lean on feeds being the prevnext config

* docs: add output_html to changelog

* do not jinja the publish_html page

* Allow extra arguments when a plugins dumps them from config

* use 3.9 to build

* implement _is_relative_to

* docs: better jinja_md docs

* absolute links so they work on any domain

* style: give headings a bit more space

* fix: some elements were using a serif font

* fix theme-switch z-index

* close 24

* close #21

* close #21

* close 13

* remove trailing whitespace

* doc pages writes to it's directory, not index

Co-authored-by: Meet Gor <40317114+Mr-Destructive@users.noreply.github.com>
WaylonWalker added a commit that referenced this issue May 23, 2022
… is all new closes #13

* deprecated: long_description has been deprecated by auto_description
* fix: [covers](/markata/plugins/covers/) plugin which would previously skip every time.
* feat: [`markata clean`](/markata/plugins/base_cli/#clean-function) cleans up your cache and output from the command line
* fix: [`publish_source`](/markata/plugins/publish_source/) plugin will now ignore any non yaml serializable values
* feat: Default template colors are now customizable
* feat: Default template now has light and dark theme
* feat: map now has the ability to map entire posts
* feat: [prevnext](/markata/plugins/prevnext/) plugin was added to link between posts closes #20
* feat: [jinja_md](/markata/plugins/jinja_md/) plugins was added to incorporate jinja into all the markdown
* breaking: [feeds](/markata/plugins/feeds) config now has feeds and feeds_config
* feat: `output_html` can now be specified in the frontmatter [see example](/markata/plugins/publish_html/#explicityly-set-the-output)
* feat: edit link is now included in the default page template closes #21

If you are using the 0.1.0 version of feeds, and have configured custom
templates in `markata.feeds.template` and `markata.feeds.card_template` they
will need to be moved to `markata.feeds_config`.

Here is what you need to do to update your feeds_config.

``` diff
+ [markata.feeds_config]
+ template="pages/templates/archive_template.html"
+ card_template="plugins/feed_card_template.html"
- [markata.feeds]
- template="pages/templates/archive_template.html"
- card_template="plugins/feed_card_template.html"
```

`markata.feeds` will only be used to configure feeds pages.

`post` is now exposed to the `markata.map` object, allowing you to return a
list of posts.

``` python
m = Markata()
m.map('post', filter='"git" in tags')
```

``` toml
[markata]
color_bg = '#1f2022'
color_bg_code = '#1f2022'
color_text = '#eefbfe'
color_link = '#47cbff'
color_accent = '#e1bd00c9'
overlay_brightness = '.85'

color_bg = 'deeppink'
color_bg_code = 'rebeccapurple'
color_text = 'white'
color_link = 'aqua'
color_accent = 'peachpuff'
overlay_brightness = '1.2'

color_bg_light = '#eefbfe'
color_bg_code_light = '#eefbfe'
color_text_light = '#1f2022'
color_link_light = '#47cbff'
color_accent_light = '#ffeb00'
overlay_brightness_light = '.95'
```

* Cache is busted on plugin change
* plugin is configurable
* plugin now has docs

Open up your `markata.toml` file and add new entries for your
auto_descriptions.  You can have multiple desriptions, each one will be named
after the key you give it in your config.

``` toml
[markata]
hooks=[
   "markata.plugins.auto_description",
   ]

[markata.auto_description.description]
len=160
[markata.auto_description.long_description]
len=250
[markata.auto_description.super_description]
len=500
```

In the above we will end up with three different descritpions,
(`description`, `long_description`, and `super_description`) each will be the
first number of characters from the document as specified in the config.

4e299d6 fixes the dedupe issue that was in develop for awhile and closes #24
WaylonWalker added a commit that referenced this issue May 23, 2022
## 0.2.0

* feat: [auto_description](/markata/plugins/auto_description/) plugin is all new closes #13
* deprecated: long_description has been deprecated by auto_description
* fix: [covers](/markata/plugins/covers/) plugin which would previously skip every time.
* feat: [`markata clean`](/markata/plugins/base_cli/#clean-function) cleans up your cache and output from the command line
* fix: [`publish_source`](/markata/plugins/publish_source/) plugin will now ignore any non yaml serializable values 
* feat: Default template colors are now customizable
* feat: Default template now has light and dark theme
* feat: map now has the ability to map entire posts
* feat: [prevnext](/markata/plugins/prevnext/) plugin was added to link between posts closes #20
* feat: [jinja_md](/markata/plugins/jinja_md/) plugins was added to incorporate jinja into all the markdown
* breaking: [feeds](/markata/plugins/feeds) config now has feeds and feeds_config
* feat: `output_html` can now be specified in the frontmatter [see example](/markata/plugins/publish_html/#explicityly-set-the-output)
* feat: edit link is now included in the default page template closes #21

### breaking change to feeds config

If you are using the 0.1.0 version of feeds, and have configured custom
templates in `markata.feeds.template` and `markata.feeds.card_template` they
will need to be moved to `markata.feeds_config`.

Here is what you need to do to update your feeds_config.

``` diff
+ [markata.feeds_config]
+ template="pages/templates/archive_template.html"
+ card_template="plugins/feed_card_template.html"
- [markata.feeds]
- template="pages/templates/archive_template.html"
- card_template="plugins/feed_card_template.html"
```

`markata.feeds` will only be used to configure feeds pages.


### map entire posts

`post` is now exposed to the `markata.map` object, allowing you to return a
list of posts.

``` python
m = Markata()
# 'post' will return the entire post
m.map('post', filter='"git" in tags')
```

### Customizable colors

``` toml 
[markata]
# default dark theme
color_bg = '#1f2022'
color_bg_code = '#1f2022'
color_text = '#eefbfe'
color_link = '#47cbff' 
color_accent = '#e1bd00c9'
overlay_brightness = '.85'

# pink and purple
color_bg = 'deeppink'
color_bg_code = 'rebeccapurple'
color_text = 'white'
color_link = 'aqua' 
color_accent = 'peachpuff'
overlay_brightness = '1.2'

# default light theme
color_bg_light = '#eefbfe'
color_bg_code_light = '#eefbfe'
color_text_light = '#1f2022'
color_link_light = '#47cbff' 
color_accent_light = '#ffeb00'
overlay_brightness_light = '.95'
```

### All New auto_description plugin

* Cache is busted on plugin change 
* plugin is configurable
* plugin now has docs

### auto_description Configuration

Open up your `markata.toml` file and add new entries for your
auto_descriptions.  You can have multiple desriptions, each one will be named
after the key you give it in your config.

``` toml
[markata]
hooks=[
   "markata.plugins.auto_description",
   ]

[markata.auto_description.description]
len=160
[markata.auto_description.long_description]
len=250
[markata.auto_description.super_description]
len=500
```

In the above we will end up with three different descritpions, 
(`description`, `long_description`, and `super_description`) each will be the
first number of characters from the document as specified in the config.

### auto_descriptions are no longer duplicated

4e299d6 fixes the dedupe issue that was in develop for awhile and closes #24

## 0.1.0

* fix: pyinstument plugin no longer overrides the main cli callback
* feat: default is to run the profiler if pyinstrument is installed
* fix: --profile is now under the build command
* feat: --pretty/--no-pretty will make pretty tracebacks, and skip over framework code (closes #4 )
* fix: links are now absolute so they work from github, thanks [MR Destructive](https://github.com/Mr-Destructive)
* deprecate: `article['content_hash']` has been removed with preference for simply hashing on `article['content']`
* create `heading_link` plugin
* doc: How to create your home page. [docs](/home-page/)

### New cli help

After the pyinstrument plugin was fixed --version and  --to-json are back, and --profile is now under the build command.

![image](https://user-images.githubusercontent.com/22648375/150662983-547aebbd-c18c-4c17-8985-a6dc01cd29c7.png)

### New Heading Link Plugin

The new heading link plugin makes it easier to share the exact part of an article you want with someone, by giving clickable links to the id of the heading it's next to.

![image](https://user-images.githubusercontent.com/22648375/151718782-08a7cd26-41c1-4f00-a12c-0a208c593e9c.png)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant