npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

walt.css

v0.1.1

Published

A minimal documentation theme

Downloads

3

Readme

walt

License PyPI GitHub Docs

Walt is a minimal documentation theme based on writ.css. It features classless styles for semantic HTML and supports light and dark mode based on system settings.

MkDocs theme

Walt is available as an MkDocs theme that features:

  • classless styles for semantic HTML based on writ.css
  • light mode and dark mode based on system settings
  • an emoji favicon for browsers that support svg site icons
  • code syntax highlighting using highlight.js

You can install it from PyPI using:

pip install mkdocs-walt

See the mkdocs directory to learn how to install and use Walt in your MkDocs projects.

Developing mkdocs-walt

Installing from source

git clone https://github.com/codesue/walt.git
cd walt/mkdocs
pip install -e .

Running the example

cd ../examples/mkdocs  # if your current working directory is walt/mkdocs
mkdocs serve

Building and distributing the package

  1. Install the necessary packages:
pip install "clementine[rind]"
  1. With walt/mkdocs as your working directory, build the package and verify the build:
python -m build
twine check dist/*
  1. Upload the package to TestPyPI:
twine upload -r testpypi dist/*

Install the package from TestPYPI in a clean virtual environment and confirm that the example runs as expected:

pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ mkdocs-walt
  1. Upload the package to PyPI:
twine upload dist/*

License

Copyright © 2023 Suzen Fylke. Distributed under the MIT License.

Acknowledgements

Walt uses writ.css for styles and examples use writ's reference html page.

Walt also uses Catppuccin for code block syntax highlighting and dark mode color palettes.