Research
Security News
Malicious npm Package Targets Solana Developers and Hijacks Funds
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
sphinx-markdown-builder
Advanced tools
A Sphinx extension to add markdown generation support.
pip3 install sphinx-markdown-builder==0.6.6
Add the extension to your conf.py
file:
extensions = [
...,
"sphinx_markdown_builder",
...,
]
Build markdown files with sphinx-build
command
sphinx-build -M markdown ./docs ./build
You can add the following configurations to your conf.py
file:
markdown_anchor_sections
/markdown_anchor_signatures
: If set to True
,
then anchors will be added before each section/function/class signature.
This allows references to a specific anchor in the document.markdown_docinfo
: Adds metadata to the top of each document containing author, copyright, and version.markdown_http_base
: If set, all references will link to this prefix addressmarkdown_uri_doc_suffix
: If set, all references will link to documents with this suffix.For example, if your conf.py
file have the following configuration:
markdown_http_base = "https://your-domain.com/docs"
markdown_uri_doc_suffix = ".html"
Then a reference to your-doc-name#your-header
will be substituted with https://your-domain.com/docs/your-doc-name.html#your-header
.
See the code contribution guidelines for more information.
This project forked from clayrisser/sphinx-markdown-builder, which was developed by Clay Risser under the MIT license.
The original implementation was based on doctree2md by Matthew Brett under the BSD-2 license.
FAQs
A Sphinx extension to add markdown generation support.
We found that sphinx-markdown-builder demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.