Giter Club home page Giter Club logo

dudebro249 / docrunner Goto Github PK

View Code? Open in Web Editor NEW
13.0 1.0 1.0 7.51 MB

A command line tool which allows you to run the code in your markdown files to ensure that readers always have access to working code.

Home Page: https://docrunner-cli.web.app

License: Apache License 2.0

JavaScript 11.33% CSS 3.38% TypeScript 17.70% Dart 59.77% PowerShell 4.08% Shell 3.73%
software-development software-testing software-testing-tools cli cli-app devops automation powertool readers powertools

docrunner's Introduction

Ayush Srinivas

Software Developer | Problem Solver | Code Enthusiast

๐Ÿ‘‹ Hi! I'm Ayush Srinivas, a passionate software developer who loves to craft elegant solutions to complex problems. My journey in the world of programming has equipped me with a diverse skill set and a commitment to continuous learning.

๐Ÿ› ๏ธ Technologies and Skills

Python JavaScript TypeScript Dart Flutter Java Rust C HTML5 CSS3 TailwindCSS Postgres Prisma React Next JS NodeJS Jest FastAPI Docker

๐Ÿš€ Notable Projects

Project 1: Docrunner

  • ๐Ÿ“‚ DudeBro249/docrunner
  • โœ๏ธ Docrunner is a powerful command line tool that provides a seamless solution for testing code within markdown files, guaranteeing that your readers always have access to accurate and working examples.
  • ๐Ÿ”— Link to Article โžก๏ธ
  • ๐Ÿ› ๏ธ Technologies Used: Dart Python JavaScript TypeScript

Project 2: GQLFake

  • ๐Ÿ“‚ DudeBro249/gqlfake
  • โœ๏ธ GQLFake is a CLI tool that can be used to create fake, structured data using GraphQL schemas to specify fields and data types.
  • ๐Ÿ”— Link to Article โžก๏ธ
  • ๐Ÿ› ๏ธ Technologies Used: TypeScript Firebase JSON

Project 3: Flutter Firebase Riverpod Boilerplate

๐Ÿ“š Education

  • Pursuing a Bachelor of Science in Computer Science ๐Ÿ’ป at Pennsylvania State University

๐ŸŒ Connect with Me

๐Ÿค Let's Connect

I'm always open to new opportunities and collaborations. If you're a recruiter or fellow developer, feel free to reach out. Let's build something amazing together!


docrunner's People

Contributors

dudebro249 avatar jbutcher5 avatar suptejas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

jbutcher5

docrunner's Issues

Documentation

  • Add documentation for cli tool. Preferably done using a website, with docusaurus.

Add support for multiple markdown files

  • Add support for multiple markdown files in docrunner.toml configuration file
  • Change the markdown_path field to markdown_paths in docrunner.toml to allow support for lists.
  • Add support for directories in markdown_paths

Support for ignoring certain snippets

  • Allow docrunner to ignore specific code snippets in markdown files if they are prefixed with some sort of delimiter, such as <!--docrunner.ignore--> which also serves as a comment and won't be shown when rendering the markdown.

Fix Bug in Docrunner File Comments

  • Fix bugs in the way docrunner parses comments above snippets
  • Fix bug in the way docrunner handles file comments. Docrunner should append to instead of rewrite code files if they are linked to more than once in a markdown file.

Rewrite Docrunner in Dart

  • Rewrite the docrunner cli tool in the dart language

Why?

  • It will allow the compilation into an exe which will not require python, or any language to be installed in order to run
  • The cli tool will be faster

Add support for custom file names in markdown

  • Users should be able to specify custom file names for snippets by prefixing the code snippet with <!--docrunner.file_name = "filename.py"--> on the line above the snippet
  • The file name that is specified should only be used if the multi_file option is set to True, either through the docrunner.toml configuration file or through a cli argument

Linux & Mac support

Currently docrunner only supports Windows, we should aim to support both mac and linux as well, this can be achieved by adding continuous deployment in the form of a Github workflow and release every time a branch is merged into the "stable" branch. In addition the shell install script must be fixed as this is installing a windows binary in a C drive on linux.

Docrunner appends output

It would be benifical to have some flag, mode or usage that would run the code snippet and append or update the output expected on the snippet or below. This would ensure that the output expected would be as upto date as it could be and that if small wording changes have happened they would be reflected in the docs.

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.