Skip to content

Commit

Permalink
Version 1.2.0 of the document
Browse files Browse the repository at this point in the history
- A bunch of edits in the article
- Moving to mkdocs
- Setting up Github CI

---------

Co-authored-by: Paul Radley <noemail>
  • Loading branch information
paulradley authored Jan 19, 2024
1 parent 2261953 commit aaa3de5
Show file tree
Hide file tree
Showing 39 changed files with 583 additions and 953 deletions.
49 changes: 49 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Build and Deploy MkDocs

on:
push:
branches:
- $default-branch

workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install Dependencies
run: pip install -r requirements.txt
- name: Build
run: mkdocs build --strict
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './build'

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
build/
venv/
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,9 @@
# Why cannot you set up Xdebug?

> ℹ️ Use issues tab to suggest changes
Most users experience difficulties with setting up [Xdebug](https://xdebug.org/) in their development environments. The problem has deteriorated due to several reasons:

- Insufficient understanding of Xdebug work
- An overload of ambiguous and inaccurate google-answers
- No out-of-the-box solution to run "in one click"

As long as the last two reasons are hard to affect, the focus of the article is decreasing impact of the first reason. So the goal is to explain how Xdebug does work under the hood, how IDE does work with Xdebug, and how the browser side has to work. The narrative format will help you systematize knowledge in an orderly manner. As a result, the acquired knowledge will reduce efforts on setting Xdebug up in an unfamiliar environment.

In addition, you will gain insights into the following related questions: what is DBGp Proxy, why you should not use Xdebug Cloud and how to set up Xdebug in nonstandard environments (like SPA application). You won't gain information about instructions for installing Xdebug extension, instructions for using the debugger.

The document is presented in two languages:

- [English](./xdebug_en.md)
- ~~[Русский](./xdebug_ru.md)~~ deprecated
The article is [here](https://paulradley.github.com/why-cannot-you-set-up-xdebug)

### TODO List

- WSL2 environment
- WSL2 environment
- SEO TAGS
- Google Analytics
14 changes: 14 additions & 0 deletions docs/assets/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.md-typeset .admonition,
.md-typeset details {
border-width: 0;
border-left-width: 4px;
font-size: .75rem;
}

.md-typeset table:not([class]) {
border-top: 0
}

.md-typeset th {
display: none;
}
35 changes: 35 additions & 0 deletions docs/assets/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/cli_mode_xdebug.webp
Binary file not shown.
Binary file added docs/img/dbgp_ide_key.webp
Binary file not shown.
Binary file added docs/img/dbgp_proxy_tool.webp
Binary file not shown.
Binary file added docs/img/multiple_projects.webp
Binary file not shown.
Binary file added docs/img/web_browser_ide_key.webp
Binary file not shown.
Binary file added docs/img/web_mode_schema.webp
Binary file not shown.
Binary file added docs/img/web_mode_simple.webp
Binary file not shown.
Binary file added docs/img/web_mode_xdebug.webp
Binary file not shown.
Binary file added docs/img/xdebug_cloud.webp
Binary file not shown.
Binary file added docs/img/xdebug_cloud_id.webp
Binary file not shown.
Loading

0 comments on commit aaa3de5

Please sign in to comment.