diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..95e2fb5 --- /dev/null +++ b/_config.yml @@ -0,0 +1,22 @@ +# GitHub Pages configuration for CrackingShells documentation +theme: minima +title: CrackingShells Documentation +description: Documentation for Hatchling and related tools + +# Enable GitHub Pages features +plugins: + - jekyll-default-layout + - jekyll-optional-front-matter + - jekyll-readme-index + - jekyll-titles-from-headings + +# Markdown processing +markdown: kramdown +highlighter: rouge + +# Exclude certain files from processing +exclude: + - README.md.backup + - vendor/ + - .git/ + - .gitignore diff --git a/hatchling-users/running_hatchling.md b/hatchling-users/running_hatchling.md index 7c241f9..d3406c7 100644 --- a/hatchling-users/running_hatchling.md +++ b/hatchling-users/running_hatchling.md @@ -10,7 +10,7 @@ You will learn about: - Starting and using Hatchling with Docker Compose # Running Hatchling -This section assumes you have followed the [docker setup](./docker-setup.md). +This section assumes you have followed the [docker setup](tutorials/docker-setup.md). In this guide, you will: @@ -146,4 +146,4 @@ Here is a screenshot of what Hatchling typically looks like right after start up ![Typical_Hatchling_CLI_20250627_pt1](../resources/images/running-hatchling/Typical_Hatchling_CLI_20250627_pt1.png) ![Typical_Hatchling_CLI_20250627_pt2](../resources/images/running-hatchling/Typical_Hatchling_CLI_20250627_pt2.png) -You can receive help about all available commands by writing `help` in the chat. Details about the commands are also available in the [documentation](./chat_commands.md) \ No newline at end of file +You can receive help about all available commands by writing `help` in the chat. Details about the commands are also available in the [documentation](./chat_commands.md) diff --git a/hatchling-users/tutorials/docker-setup.md b/hatchling-users/tutorials/docker-setup.md index 22db8b4..66eb455 100644 --- a/hatchling-users/tutorials/docker-setup.md +++ b/hatchling-users/tutorials/docker-setup.md @@ -76,8 +76,8 @@ This document provides instructions on how to set up and run the project using D ## Next Step -[Running Hatchling](./running_hatchling.md) +[Running Hatchling](../running_hatchling.md) ## Additional Resources -- [Docker Documentation](https://docs.docker.com/) \ No newline at end of file +- [Docker Documentation](https://docs.docker.com/) diff --git a/resources/images/docker-setup/Run_Ollama_Container.png b/resources/images/docker-setup/Run_Ollama_Container.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/docker-setup/Run_Ollama_Container.png differ diff --git a/resources/images/docker-setup/docker_find_container.png b/resources/images/docker-setup/docker_find_container.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/docker-setup/docker_find_container.png differ diff --git a/resources/images/docker-setup/docker_find_container_log.png b/resources/images/docker-setup/docker_find_container_log.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/docker-setup/docker_find_container_log.png differ diff --git a/resources/images/docker-setup/docker_find_image.png b/resources/images/docker-setup/docker_find_image.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/docker-setup/docker_find_image.png differ diff --git a/resources/images/docker-setup/docker_quit_large.png b/resources/images/docker-setup/docker_quit_large.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/docker-setup/docker_quit_large.png differ diff --git a/resources/images/docker-setup/docker_restart_large.png b/resources/images/docker-setup/docker_restart_large.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/docker-setup/docker_restart_large.png differ diff --git a/resources/images/docker-setup/docker_settings_position.png b/resources/images/docker-setup/docker_settings_position.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/docker-setup/docker_settings_position.png differ diff --git a/resources/images/docker-setup/docker_terminal_position.png b/resources/images/docker-setup/docker_terminal_position.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/docker-setup/docker_terminal_position.png differ diff --git a/resources/images/running-hatchling/Typical_Hatchling_CLI_20250627_pt1.png b/resources/images/running-hatchling/Typical_Hatchling_CLI_20250627_pt1.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/running-hatchling/Typical_Hatchling_CLI_20250627_pt1.png differ diff --git a/resources/images/running-hatchling/Typical_Hatchling_CLI_20250627_pt2.png b/resources/images/running-hatchling/Typical_Hatchling_CLI_20250627_pt2.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/running-hatchling/Typical_Hatchling_CLI_20250627_pt2.png differ diff --git a/resources/images/running-hatchling/deepseek_model_page_example.png b/resources/images/running-hatchling/deepseek_model_page_example.png new file mode 100644 index 0000000..e834544 Binary files /dev/null and b/resources/images/running-hatchling/deepseek_model_page_example.png differ