diff --git a/docs/languages/c.md b/docs/languages/c.md index ba8a914..0354bf6 100644 --- a/docs/languages/c.md +++ b/docs/languages/c.md @@ -12,3 +12,18 @@ require("Polydev").c.setup({ ["nh"] = "NewCHeaderFile", -- Creates a new header file in the current project src folder }) ``` + +## File Structure +```md +Projects/ +└── C/ + └── Project_Name/ + ├── CMakeLists.txt + ├── src/ + │ ├── main.c + │ └── *.c + ├── build/ + │ └── .polydev + └── include/ + └── *.h +``` diff --git a/docs/languages/java.md b/docs/languages/java.md index 071621d..42b3d35 100644 --- a/docs/languages/java.md +++ b/docs/languages/java.md @@ -10,3 +10,14 @@ require("Polydev").java.setup({ } }) ``` +## File Structure + +```md +Projects/ +└── Java/ + └── Project_Name/ + ├── src/ + │ └── Main.java + └── build/ + └── *.class +``` diff --git a/docs/languages/lua.md b/docs/languages/lua.md new file mode 100644 index 0000000..b4520ca --- /dev/null +++ b/docs/languages/lua.md @@ -0,0 +1,22 @@ +## Keybinds +```lua +-- These are the defaults for lua +require("Polydev").lua.setup({ + keybinds = { + [""] = "CloseTerminal", + ["pr"] = "LuaRun", + ["nf"] = "NewLuaFile", + } +}) +``` + +## File Structure +```md +Projects/ +└── Lua/ + └── Project_Name/ + ├── .polydev + └── lua/ + └── Project_name/ + └── init.lua +``` diff --git a/docs/languages/python.md b/docs/languages/python.md new file mode 100644 index 0000000..63a625f --- /dev/null +++ b/docs/languages/python.md @@ -0,0 +1,27 @@ +## Keybinds +```lua +require("Polydev").python.setup({ + keybinds = { + [""] = "CloseTerminal", + ["pr"] = "PythonRun", + ["nf"] = "NewPythonFile", + ["pb"] = "PythonPip" + } +}) +``` + +## Python Features +* A feature that is added to the python language for this plugin is to be able to install dependencies with pip within the terminal. You can even update pip. Just type your dependency you want and boom it is installed or not depending on if python likes you. + +## File Structure +```md +Projects/ +└── Python/ + └── Project_Name/ + ├── main.py + ├── requirements.txt + ├── setup.py + ├── tests/ + └── venv/ + +``` diff --git a/mkdocs.yml b/mkdocs.yml index 691f37c..dd63759 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,7 +6,9 @@ nav: - Examples: examples.md - Language Specific Docs: - Java: languages/java.md - - C: languages/c.md + - C: languages/c.md + - Lua: languages/lua.md + - Python: languages/python.md theme: name: material features: