diff --git a/README.md b/README.md index 7844141..f10401a 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,24 @@ users learn the language. | 5 | OOP: Embracing object-oriented programming in Python | | 6 | Strings: The gory details of strings and formatting. | +## omg the link stuff. +Site-absolute. (currently links to `source/example.md`): +[Syntax Basics](source/example.md) +[Primer 1](./primer01_basics.md) +[Primer 2](./primer02_suites.md) +[Primer 3](./primer03_fileIO.md) +[Primer 3](./primer04_modules.md) + +[Syntax Basics](python_syntax/blob/website/source/example.md) + +Relative-up (currently links to `../source/example.md`): +[Syntax Basics](../source/example.md) + +### Internal to `Docs` links: +[test page](test.md) +[test page](./docs/test.md) +[test page](docs/test.md) + ## Using These Tutorials All files are markdown-formatted Jupyter notebooks. @@ -44,7 +62,7 @@ on your machine. [Information on installing and using Jupytext can be found here.](https://jupytext.readthedocs.io/en/latest/index.html) Finally, Jupyter-nbconvert is required for generation of HTML or PDF versions -of the tutorials. +of the tutorials. Typical installation on a Debian-like machine will look like this: diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..85b5189 --- /dev/null +++ b/_config.yml @@ -0,0 +1,2 @@ +theme: jekyll-theme-hacker +markdown: kramdown diff --git a/docs/README.md b/docs/README.md index 469fd47..99bd7ea 100644 --- a/docs/README.md +++ b/docs/README.md @@ -29,15 +29,29 @@ Absolute: [Syntax Basics](https://github.com/spacecataz/python_syntax/blob/main/primer01_basics.md) Relative: +links to ../primer01_basics.md [Syntax Basics](../primer01_basics.md) Using `/` as repository root: +links to /primer01_basics.md [Syntax Basics](/primer01_basics.md) ## Trying links with a file inside `/docs/`: -Absolute: -[Syntax Basics](https://github.com/spacecataz/python_syntax/blob/main/docs/example.md) - -Relative: -[Syntax Basics](example.md) +Absolute currently links to `the-whole-url/source/example.md`: +[Syntax Basics](https://github.com/spacecataz/python_syntax/blob/main/source/example.md) + +Site-absolute. (currently links to `/source/example.md`): +[Syntax Basics](./source/example.md) +[Syntax Basics](python_syntax/source/example.md) +[Syntax Basics](/python_syntax/source/example.md) +[Syntax Basics](python_syntax/blob/website/source/example.md) +[Syntax Basics](python_syntax/blob/website/source/example.md) + +Relative-up (currently links to `../source/example.md`): +[Syntax Basics](../source/example.md) + +### Internal to `Docs` links: +[test page](test.md) +[test page](./docs/test.md) +[test page](docs/test.md) \ No newline at end of file diff --git a/docs/test.md b/docs/test.md new file mode 100644 index 0000000..b69b581 --- /dev/null +++ b/docs/test.md @@ -0,0 +1,2 @@ +# Another page. +another page. \ No newline at end of file diff --git a/docs/example.md b/source/example.md similarity index 100% rename from docs/example.md rename to source/example.md