Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
book-open

GitHub Action

WikiLeet

v3.0.0 Pre-release

WikiLeet

book-open

WikiLeet

Automatically parse your LeetCode submissions and generate a navigatable wiki of your solutions

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: WikiLeet

              
  uses: Zanger67/WikiLeet@v3.0.0
Learn more about this action in Zanger67/WikiLeet

Choose a version

Wiki Leet

Click here for a sample repo (my LeetCode repo)

WikiLeet is a program that takes your local LeetCode submissions and organizes them into a navigatable wiki-like set of markdown files giving you an aesthetically pleasing README to view your journey. See the link above for my own LeetCode repo as an example.

Using GitHub actions, it will run everytime you commit a new submission to your linked repo, updating all the markdown links in the process.

Additional Features

  • Categories

    • The NeetCode150 and Blind75 lists have been added.
    • If you put "Daily" or "Weekly Premium" in the file's name, it will categorize them as such.

  • Each question

    • Contains a completion date, last attempted date, acceptance rate, related topics, languages used, etc.
    • Each question has a markdown generated containing all solutions (if you have multiple) with all relevant details.
    • If you create a .txt or .md file with a question number (e.g. 1234.py), it will be inserted as a "summary" in the question's markdown. I personally use this to place my notes that I created while working on the problem. Click here for an example.

  • Contests

    • In your submissions folder, if you want contests to be group, you can create a folder.
    • Any questions in that folder will be attributed to the contest of the folder's name. Click here for an example.

  • Auto-uploading submissions

    • If you use extensions that automatically pulll your submissions, as long as the question's number is present in the file name and it's not in a folder, it will work perfectly.
    • E.g. with the vscode-leetcode extension, you can set the my-submissions as the file store location and the script will parse it all the same.

  • Creation and modification dates

    • Default times are set based off of UTC commit times since that's what LeetCode goes off of.
    • These are tracked based off of your commit history by default. The script parses every file associated with a question up it's commit log finding the earliest and latest dates.
    • If ran manually, this can be done using the file creation and modification dates.
    • Warning: parsing the git commit history of each file is slow when done locally it seems but on GitHub actions, it's relatively fast. I'm not sure why this is, but to run locally look at the flag instructions for -n and -g in the main.py file's main().

How to Use

Automatic GitHub Action (Recommended)

There are two straightforward options:

  1. Fork this template repo.

or

  1. Add generate-markdowns.yml as a GitHub action in any repository that contains a directory called my-submissions.

Make sure to add your GitHub PAT with repository read/write permissions as a repository secret under the name PAT for this to work. See here for help with PAT setup.

Update the default .env with your LeetCode username.

Running Locally

The program can be ran locally once imported as a submodule.

About files and directories

File / Directory Details
question_data/ Contains .json and .pkl files with question information such as AC rates, related topics, titles, etc. This is done to avoid constantly querying the Leetcode server and is automated within this repo.
user_data/ A .gitignored folder that will store the last modified date of each question so it doesn't unnecessarily reprocess questions that haven't changed. This only applies to local runs of the script.
Lists/ .txt files with lists such as the NeetCode150 and Blind75 (see the readme in this folder for more information).
.env A config file template that you should edit with your own information, namely your LeetCode username.
main.ipynb The main program that parses all your code and generates the markdowns.
main.py The exported version of main.ipynb for easier running (type python main.py).
parse_official_question_data.ipynb A helper script that I use to reprocess the .json data (you can ignore).
LeetCode Record - Publix.xlsx The spreadsheet I use to track my progress with cumulative graphs and whatnot (extra)

EXAMPLES

Click here to see my own repo as an example


My Repo's Homepage (the Primary README)

Leetcode Repository Example

A single question markdown which was generated from 2 solution files and a context file to add details

Individual Question's Markdown Example

The pre-rendered markdown

Markdown Code Example

Spreadsheet Example

Future Additions Planned

  • Auto detection for Daily and Weekly Premium questions (e.g. commit time +/- 1 day)