🚧 Docs Update, Changelog, Design, Fonts (#5)
Updated to include v3.8 release details. Added a warning to update to v3.8 or the latest version. Changed fonts to Nuito Sans for easier readability. Bumped requirements. Deleted runtime.txt. Signed-off-by: darrenofficial <git@darrennathanael.com> Reviewed-on: #5 Co-authored-by: Darren Nathanael <github@darrennathanael.com> Co-committed-by: Darren Nathanael <github@darrennathanael.com>
This commit is contained in:
parent
983f70f1db
commit
b98665faf2
|
|
@ -0,0 +1,3 @@
|
|||
# Default ignored files
|
||||
/shelf/
|
||||
/workspace.xml
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module type="PYTHON_MODULE" version="4">
|
||||
<component name="NewModuleRootManager">
|
||||
<content url="file://$MODULE_DIR$">
|
||||
<excludeFolder url="file://$MODULE_DIR$/.venv" />
|
||||
</content>
|
||||
<orderEntry type="inheritedJdk" />
|
||||
<orderEntry type="sourceFolder" forTests="false" />
|
||||
</component>
|
||||
<component name="PyDocumentationSettings">
|
||||
<option name="format" value="PLAIN" />
|
||||
<option name="myDocStringFormat" value="Plain" />
|
||||
</component>
|
||||
</module>
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
<component name="InspectionProjectProfileManager">
|
||||
<settings>
|
||||
<option name="USE_PROJECT_PROFILE" value="false" />
|
||||
<version value="1.0" />
|
||||
</settings>
|
||||
</component>
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="Black">
|
||||
<option name="sdkName" value="Python 3.12 (dpaste-docs)" />
|
||||
</component>
|
||||
<component name="DiscordProjectSettings">
|
||||
<option name="show" value="ASK" />
|
||||
<option name="description" value="" />
|
||||
</component>
|
||||
<component name="ProjectRootManager" version="2" project-jdk-name="Python 3.12 (dpaste-docs)" project-jdk-type="Python SDK" />
|
||||
</project>
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="ProjectModuleManager">
|
||||
<modules>
|
||||
<module fileurl="file://$PROJECT_DIR$/.idea/dpaste-docs.iml" filepath="$PROJECT_DIR$/.idea/dpaste-docs.iml" />
|
||||
</modules>
|
||||
</component>
|
||||
</project>
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="VcsDirectoryMappings">
|
||||
<mapping directory="" vcs="Git" />
|
||||
</component>
|
||||
</project>
|
||||
|
|
@ -1,10 +1,23 @@
|
|||
Changelog
|
||||
=========
|
||||
|
||||
3.8 (master)
|
||||
|
||||
??? danger "Please update your dpaste instance to v3.8 / latest!"
|
||||
|
||||
3.9 (master)
|
||||
------------
|
||||
TBD
|
||||
|
||||
3.8 (2023-09-18)
|
||||
------------
|
||||
|
||||
- Typo(s) fixes
|
||||
- API sanitizing
|
||||
- .gitignore
|
||||
- Addresses Typo in Cleanup Snippes
|
||||
- Addresses [CVE-2023-49277](https://nvd.nist.gov/vuln/detail/CVE-2023-49277)
|
||||
|
||||
|
||||
|
||||
3.7 (2022-06-03)
|
||||
------------
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Dpaste Documentation
|
||||
<h1 style="font-family:Nunito Sans;font-size: 2.5em;font-weight: bold;color: white;">Dpaste Documentation</h1>
|
||||
|
||||
|
||||
[](https://github.com/DarrenOfficial/dpaste/actions/workflows/python.yml)
|
||||
|
|
@ -17,4 +17,6 @@ The project is intended to run standalone as any regular Django Project, but it'
|
|||
|
||||
The code is open source and available on Github: [https://github.com/DarrenOfficial/dpaste](https://github.com/DarrenOfficial/dpaste). If you found bugs, have problems or ideas with the project or the website installation, please create an *Issue* there.
|
||||
|
||||
For security vulnerability disclosure please contact darren@dpaste.org
|
||||
|
||||
⚠️ dpaste requires at a minimum Python 3.6 and Django 2.2.
|
||||
|
|
|
|||
22
mkdocs.yml
22
mkdocs.yml
|
|
@ -4,32 +4,22 @@ site_url: https://docs.dpaste.org
|
|||
site_description: >-
|
||||
dpaste is a pastebin application written in Python using the Django framework.
|
||||
You can find a live installation on dpaste.org.
|
||||
repo_url: 'https://github.com/DarrenOfficial/dpaste'
|
||||
repo_url: 'https://git.dpaste.org/dpaste/dpaste-docs/'
|
||||
repo_name: 'dpaste'
|
||||
edit_uri: 'https://github.com/DarrenOfficial/dpaste-docs/edit/main/docs'
|
||||
logo: 'https://darrennathanael.com/favicon.png'
|
||||
edit_uri: 'https://git.dpaste.org/dpaste/dpaste-docs/edit/main/docs'
|
||||
|
||||
theme:
|
||||
palette:
|
||||
- scheme: slate
|
||||
primary: 'black'
|
||||
accent: 'green'
|
||||
toggle:
|
||||
icon: material/weather-night
|
||||
name: Switch to light mode
|
||||
- scheme: default
|
||||
primary: 'teal'
|
||||
accent: 'green'
|
||||
toggle:
|
||||
icon: material/weather-sunny
|
||||
name: Switch to dark mode
|
||||
|
||||
include_search_page: false
|
||||
search_index_only: true
|
||||
name: material
|
||||
font:
|
||||
text: "Red Hat Text"
|
||||
code: "Roboto Mono"
|
||||
text: Nunito Sans
|
||||
favicon:
|
||||
'https://darrennathanael.com/favicon.png'
|
||||
'https://lore.dpaste.org/g-brand/v1/favicon-16x16.png'
|
||||
features:
|
||||
- tabs
|
||||
- instantsite
|
||||
|
|
|
|||
|
|
@ -1,6 +1,18 @@
|
|||
jinja2<3.1
|
||||
# Requirements for core
|
||||
jinja2
|
||||
markdown
|
||||
mkdocs
|
||||
mkdocs-material<9.2.5
|
||||
mkdocs-material
|
||||
pygments
|
||||
pymdown-extensions
|
||||
markdown-meta-extension
|
||||
|
||||
# Requirements for plugins
|
||||
babel
|
||||
colorama
|
||||
paginate
|
||||
regex
|
||||
mkdocs-git-authors-plugin
|
||||
mkdocs-git-revision-date-localized-plugin
|
||||
mkdocs-minify-plugin
|
||||
mkdocs-toc-sidebar-plugin
|
||||
pymdown-extensions
|
||||
|
|
@ -1 +0,0 @@
|
|||
3.7
|
||||
Loading…
Reference in New Issue