STKLR is a tool to help you automatically link up named stuff in your rust docs!

Last update: Oct 25, 2022

Overview

   _____ _______ _  ___      _____  
  / ____|__   __| |/ / |    |  __ \ 
 | (___    | |  | ' /| |    | |__) |
  \___ \   | |  |  < | |    |  _  / 
  ____) |  | |  | . \| |____| | \ \ 
 |_____/   |_|  |_|\_\______|_|  \_\

Pronounced 'stickler'.

Summary:

My favourite feature of rust-doc (the tool that automatically generates documentation from a paticular kind of docstring you can use in rust codebases) is the keyword linking. My least favourite feature of rust-doc is trying to remember to do said linking, or syntax highlighting in general as, I usually edit markdown (what rust-doc essentially makes) in a specific tool for it.

So, I made a tool to do it for me -- if you too are like me, perhaps it'll not only bring you joy, but also up the quality of your crate's docs.

Installation:

cargo install --git https://github.com/alphastrata/stklr

NOTE THIS APP IS BETA AT BEST, IT'S A WIP.

Usage:

Backup your codebase before using this, use source-control.

stklr # will bring up the help menu.
stklr preview #will show you changes it wants to make, changes are in green, source files and line numbers etc are all there.
stklr fix# will make changes to all the files you saw above, with preview.

Bugs:

Make in issue/PR -- include the text that threw it off.

Contributing:

not yet.

More release platforms etc:

later, not in beta stage.

You might also like...

Vari (Väri) is a Rust library for formatting strings with colors and cosmetic stuff to the terminal.

Vari Vari (Väri) is a Rust library for formatting strings with colors and cosmetic stuff to the terminal. Like Rich library for Python. Väri means "co

13 Nov 2, 2022

ratlab is a programming platform designed loosely for hobbyist and masochist to analyse and design stuff and things that transform our world?

ratlab A programming language developed by Quinn Horton and Jay Hunter. ratlab is a programming platform designed loosely for hobbyists and masochists

10 Sep 4, 2023

Plain Rust wrapper of Ableton Link's C 11 extension

rusty_link rusty_link is a Rust wrapper of abl_link, which is a C 11 extension for Ableton Link, provided by Ableton. This library attempts to be most

7 Jan 7, 2023

A crate to help you copy things into raw buffers without invoking spooky action at a distance (undefined behavior).

🗜 presser Utilities to help make copying data around into raw, possibly-uninitialized buffers easier and safer. presser can help you when copying dat

131 Mar 16, 2023

Fetch and extract HTML's title and description by given link.

extd Fetch and extract HTML's title and description by given link. Usage in Cargo.toml: [dependencies] extd = "0.1.4" Example use extd::extract_td; f

4 Nov 4, 2022

A fediverse compatible forum and link aggregator. Downstream from Lemmy.

Pangora A fediverse compatible forum and link aggregator. Downstream from Lemmy. About The Project Pangora is a forum and link aggregator. You can pos

7 Sep 11, 2023

A Yocto setup and management tool that helps you keep your environment up-to-date and in-sync with your team

yb (Yocto Buddy) yb is designed to make it easy to setup and (perhaps more importantly) keep Yocto environments up-to-date and in-sync with your team.

13 Oct 31, 2022

zigfi is an open-source stocks, commodities and cryptocurrencies price monitoring CLI app, written fully in Rust, where you can organize assets you're watching easily into watchlists for easy access on your terminal.

zigfi zigfi is an open-source stocks, commodities and cryptocurrencies price monitoring CLI app, written fully in Rust, where you can organize assets

18 Oct 24, 2022

An utility application to help managing your C++ OI workspaces.

oi_helper oi_helper is an utility application to help managing your C++ OI workspaces. Why oi_helper We all know that we often need a project manager

11 Aug 24, 2022

STKLR is a tool to help you automatically link up named stuff in your rust docs!

Related tags

Overview

Summary:

Installation:

NOTE THIS APP IS BETA AT BEST, IT'S A WIP.

Usage:

Bugs:

Contributing:

More release platforms etc:

You might also like...

Vari (Väri) is a Rust library for formatting strings with colors and cosmetic stuff to the terminal.

ratlab is a programming platform designed loosely for hobbyist and masochist to analyse and design stuff and things that transform our world?

Plain Rust wrapper of Ableton Link's C 11 extension

A crate to help you copy things into raw buffers without invoking spooky action at a distance (undefined behavior).

Fetch and extract HTML's title and description by given link.

A fediverse compatible forum and link aggregator. Downstream from Lemmy.

A Yocto setup and management tool that helps you keep your environment up-to-date and in-sync with your team

zigfi is an open-source stocks, commodities and cryptocurrencies price monitoring CLI app, written fully in Rust, where you can organize assets you're watching easily into watchlists for easy access on your terminal.

An utility application to help managing your C++ OI workspaces.

Releases(v0.0.42)

v0.0.42(Oct 12, 2022)

Owner

Jer

A CLI tool which can help you automatically kill process of your choice. Useful for freeing up memory and CPU usage!

fas stand for Find all stuff and it's a go app that simplify the find command and allow you to easily search everything you nedd

A Turing-complete but dead-simple spaced repetition CLI that helps you learn stuff.

A community fork of a language named after a plant fungus

This automatically patches the RoPro extension for you, allowing you to have pro_tier for free.

laydown is a simple CLI application to help you prepare for your next Daily Standup

This CLI will help you improve your typing accuracy and speed

Introducing Inlyne, a GPU powered yet browsless tool to help you quickly view markdown files in the blink of an eye.

GPT-3 powered CLI tool to help you remember bash commands.

TTAutoRecord is a tool to automatically download TikTok Livestreams of users you follow.