Code Monkey home page Code Monkey logo

lexify.md's Introduction

Lexify.md

Let's agree on terminology

Lexify.md is a tool for managing project vocabulary directly within your codebase: GLOSSARY.md in the root of your project.

It helps developers maintain consistency and clarity by easily adding, removing, updating, and linking glossary terms to their project and make it part of the code.

Features

  • Add new terms with their definitions to the glossary.
  • Remove existing terms from the glossary.
  • Update definitions of existing terms in the glossary.
  • Automatically create links to glossary terms within project documentation.

Install and Usage

Install pipx if not available: https://pipx.pypa.io/stable/installation/

pipx install git+https://github.com/alex-but/lexify.md
Usage: lexify [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  add    <key>=<definition> : Adds the <key> to the dictionary
  init                      : Creates a new empty GLOSARRY.md file following lexify format
  remove <key>              : Removes the <key> from dictionary 
  update <key>=<definition> : Updates the definition of <key>
  read   <key>              : reads the description of <key>

lexify.md's People

Contributors

alex-but avatar

Watchers

avatar

lexify.md's Issues

Bug fixing after v1.0.0

  • alphabetical order regardless of lower / upper case
  • keys can have spaces
  • keys are in a range of size (from 1 to 100 characters)

Create project architecture.

I need this to be able to start writing tests.

What should happen:

  • pick up a templating application.
  • create the functional flow for:
    • init
    • add
    • remove
    • update

Add project requirements

Define the project (business) requirements:

  • do online research.
  • Create a template
  • create requirements

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.