Skip to content

Commit

Permalink
Merge pull request #41 from markmap/project-transfer
Browse files Browse the repository at this point in the history
Project transfer
  • Loading branch information
neatc0der authored Aug 25, 2022
2 parents b31563c + ee1c3f7 commit 8679dd5
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 18 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

> Beautiful and simple mindmaps written in markdown.
[![MIT license](https://badgen.net/github/license/neatc0der/mkdocs-markmap)](https://github.com/neatc0der/mkdocs-markmap/blob/master/LICENSE)
[![MIT license](https://badgen.net/github/license/markmap/mkdocs-markmap)](https://github.com/markmap/mkdocs-markmap/blob/master/LICENSE)
[![PyPI](https://badgen.net/pypi/v/mkdocs-markmap)](https://pypi.org/project/mkdocs-markmap/)
[![Latest Release](https://badgen.net/github/release/neatc0der/mkdocs-markmap/latest)](https://github.com/neatc0der/mkdocs-markmap/releases/latest)
[![Open Issues](https://badgen.net/github/open-issues/neatc0der/mkdocs-markmap)](https://github.com/neatc0der/mkdocs-markmap/issues)
[![Open PRs](https://badgen.net/github/open-prs/neatc0der/mkdocs-markmap)](https://github.com/neatc0der/mkdocs-markmap/pulls)
[![Latest Release](https://badgen.net/github/release/markmap/mkdocs-markmap/latest)](https://github.com/markmap/mkdocs-markmap/releases/latest)
[![Open Issues](https://badgen.net/github/open-issues/markmap/mkdocs-markmap)](https://github.com/markmap/mkdocs-markmap/issues)
[![Open PRs](https://badgen.net/github/open-prs/markmap/mkdocs-markmap)](https://github.com/markmap/mkdocs-markmap/pulls)

This is a plugin and an extension for [mkdocs](https://github.com/mkdocs/mkdocs/) to add [markmap](https://github.com/gera2ld/markmap).
This is a plugin and an extension for [mkdocs](https://github.com/mkdocs/mkdocs/) to add [markmap](https://github.com/markmap/markmap).

## Prerequisits

Expand Down Expand Up @@ -73,17 +73,17 @@ plugins:
encoding: utf-8
file_extension: .mm.md
d3_version: 6.7.0
lib_version: 0.11.6
view_version: 0.2.6
lib_version: 0.14.1
view_version: 0.14.0
```
In addition, feel free to define your favourite source urls like this:
```yaml
extra_javascript:
- https://unpkg.com/[email protected]/dist/d3.min.js
- https://unpkg.com/markmap-lib@0.11.6/dist/browser/index.min.js
- https://unpkg.com/markmap-view@0.2.6/dist/index.min.js
- https://unpkg.com/markmap-lib@0.14.1/dist/browser/index.min.js
- https://unpkg.com/markmap-view@0.14.0/dist/index.min.js
```
:warning: The urls need to contain one of these keywords to be considered as deviation from default:
Expand Down Expand Up @@ -120,6 +120,6 @@ Usually proxies should be supported by `requests`, which is used for downloading
Some of the development approaches are based on implementations provided by the following projects:
* [markmap](https://github.com/gera2ld/markmap) (key feature of this project)
* [markmap](https://github.com/markmap/markmap) (key feature of this project)
* [markdown-include](https://github.com/cmacmackin/markdown-include) (basis for extension support)
* [mkdocs-mermaid2-plugin](https://github.com/fralau/mkdocs-mermaid2-plugin) (basis for plugin support)
6 changes: 6 additions & 0 deletions changelog/v2.3.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# v2.3.0

* Updates markmap-lib to `0.14.1`
* Updates markmap-view to `0.14.0`
* Updated python dependency to `>=3.7`
* Updates repository name to `markamp/mkdocs-markmap`
5 changes: 3 additions & 2 deletions mkdocs_markmap/__meta__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
PACKAGE_NAME: str = 'mkdocs_markmap'
PROJECT_NAME: str = PACKAGE_NAME.replace('_', '-')
PROJECT_VERSION: str = '2.2.2'
PROJECT_VERSION: str = '2.3.0'

OWNER: str = 'neatc0der'
REPOSITORY_NAME: str = f'{OWNER}/{PROJECT_NAME}'
ORGANISATION: str = 'markmap'
REPOSITORY_NAME: str = f'{ORGANISATION}/{PROJECT_NAME}'
REPOSITORY_URL: str = f'https://github.com/{REPOSITORY_NAME}'
4 changes: 2 additions & 2 deletions mkdocs_markmap/defaults.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ class JsModuleConfig(object):
)

MARKMAP_LIB: JsModuleConfig = JsModuleConfig(
version='0.11.6',
version='0.14.1',
uri='https://unpkg.com/markmap-lib@{}/dist/browser/index.min.js',
)

MARKMAP_VIEW: JsModuleConfig = JsModuleConfig(
version='0.2.6',
version='0.14.0',
uri='https://unpkg.com/markmap-view@{}/dist/index.min.js',
)

Expand Down
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from setuptools import setup, find_packages
from typing import List

from mkdocs_markmap.__meta__ import PROJECT_NAME, PROJECT_VERSION, REPOSITORY_URL
from mkdocs_markmap.__meta__ import OWNER, PROJECT_NAME, PROJECT_VERSION, REPOSITORY_URL


def readme() -> str:
Expand Down Expand Up @@ -31,21 +31,21 @@ def get_requirements(filename: str, base_dir: str = 'requirements') -> List[str]
long_description_content_type='text/markdown',
keywords='mkdocs python markdown markmap mindmap include',
url=REPOSITORY_URL,
author='neatc0der',
author=OWNER,
author_email='',
license='MIT',
python_requires='>=3.6',
python_requires='>=3.7',
install_requires=get_requirements('prod.txt'),
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Intended Audience :: Information Technology',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
],
packages=find_packages(exclude=['*.tests']),
package_dir={
Expand Down

0 comments on commit 8679dd5

Please sign in to comment.