Comments (8)
from pyfunceble.
Why not just use the gh wiki?? it is the same structure and you only need to transform month of my works once!
from pyfunceble.
It's also a syntax conversion a lot of things won't change.
I also want the documentation to be a bit more "modern" looking. Right now, we can't embed any example asciinema videos ... 😞
See by yourself how it looks now:
git checkout switch-to-mkdocs
# activate environemt
virtualenv -p python3 venv
. venv/bin/activate
pip install -e .[full]
# Serve documentation locally.
mkdocs serve
# Open Documentation with browser.
palemoon http://127.0.0.1:8000
from pyfunceble.
Not spend a lot on this one, but ran into this error
mkdocs serve
Error: MkDocs encountered an error parsing the configuration file: while constructing a Python object
cannot find module 'material.extensions.emoji' (No module named 'material.extensions')
in "$SOME_PATH/funilrys/pyfunceble/mkdocs.yml", line 48, column 20
from pyfunceble.
Nice catch. I really need to start testing everything inside a container ...
from pyfunceble.
Patch is on its way.
from pyfunceble.
A short first hand impression... 😒 The white background is a killer. I would also recommend using a background color in the banner of the same green as your logo.
Browsing structure... not worse, but images are not loaded as you might have expected
These are only first hand impression, and I will spend some time reviewing the code in competition of JetBrains witerside, Yet another markdown tool that allows you to do a lot of cool stuff(config) and controlling the behavior. (Free tool), this again in competition to the YouTrack(paid version, but no diff to free version) knowledge base, which includes a issue board that can interact with Github/Gitlab issues. And a helpdesk Requires login, but the submitform is HTML based and is designed to be included in any other html based page.
The preview should be available at https://kb.mypdns.org/articles/PF-A-1/PyFunceble (Once the accessibility have been solved by JetBrains support)
from pyfunceble.
@funilrys You can download https://github.com/spirillen/PyFunceble/tree/spirillen-writerside-v.0.1a and have a preview for the docs written with the writerside tool, the page I have been playing the most with is lookup.html
where you can see examples of features I'm not aware of should be available to mkdocs.
Next I will fill the gh wiki for comparison https://github.com/spirillen/PyFunceble/wiki
Please let me know what you choose as I might be open for helping transferring the docs into new format
UPDATE: Dropped the WIKI, it just sucks...
from pyfunceble.
Related Issues (20)
- FEATURE: Preload/Continue like the CI workflow ... but without Git HOT 2
- BUG: Cant install latest version with pip HOT 2
- BUG: urls in domain lists.... HOT 2
- FEATURE: Special Rules for forumactif.com HOT 1
- Contribution Tracking
- BUG: URL in file header should be changed
- BUG: dead domain query HOT 9
- BUG: sqlalche braekes after finishing...
- FEATURE: Reputation filter using the proxy connection HOT 3
- FEATURE: Sharing WHOIS
- FEATURE: meilisearch or redis support vs RamDrive
- BUG: TypeError(f"<data> should be {dict}, {type(data)} given.") HOT 5
- BUG: log file not created... HOT 2
- Special Rules, are they working as expected? HOT 2
- Unstable special rules HOT 1
- BUG: Object of type datetime is not JSON serializable HOT 2
- FEATURE: Timestamp in CLI output
- BUG: domains can't start with a dot... HOT 2
- pyfunceble.funilrys.com
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pyfunceble.