James Willett
James Willett
  • 28
  • 246 014
Material for MkDocs: Full Tutorial To Build And Deploy Your Docs Portal
🚀 Material for MkDocs is a powerful, easy to use framework designed to make your documentation both beautiful and efficient. This step-by-step guide shows you how to build a complete documentation portal from scratch and deploy it on the internet via GitHub pages.
#MkDocs #MaterialMkDocs #MaterialForMkDocs #Documentation #TechnicalDocumentation
Subscribe to the channel for more videos like this one: www.youtube.com/@james-willett?sub_confirmation=1
▬▬▬▬▬▬ 🔗 Additional Info 🔗 ▬▬▬▬▬▬
🔗 Written Guide For This Video: jameswillett.dev/getting-started-with-material-for-mkdocs/
🔗 Supporting GitHub Repo For This Video: github.com/james-willett/material-mkdocs-youtube-2024
🔗 Material for MkDocs Homepage: squidfunk.github.io/mkdocs-material/
🔗 Pygment Lexers: pygments.org/docs/lexers/
▬▬▬▬▬▬ 💰 Sponsorships 💰 ▬▬▬▬▬▬
If you are interested in sponsoring this channel, please use
calendly.com/the-james-willett/30min to book a timeslot and we can discuss further.
Alternatively please contact me on one of the channels below 👇
▬▬▬▬▬▬ 👋 Contact me 👋 ▬▬▬▬▬▬
➡ Email: info@james-willett.com
➡ LinkedIn: www.linkedin.com/in/willettjames/
➡ X / Twitter: x.com/TheJamesWillett
▬▬▬▬▬▬ ⏱ Timecodes ⏱ ▬▬▬▬▬▬
(00:00:00) Intro
(00:01:33) MkDocs vs Material for MkDocs
(00:02:40) Prerequisites
(00:03:11) Demo Prerequisites
(00:03:49) Initial Installation
(00:05:54) MkDocs Schema Validation
(00:07:22) Setting the color scheme
(00:09:16) Setting the font
(00:10:39) Setting up Emojis
(00:11:43) Icons and logos
(00:13:41) Code blocks
(00:16:10) Content tabs
(00:17:32) Admonitions (aka callouts)
(00:18:58) Diagrams
(00:20:50) Setting the footer
(00:22:17) Publishing our site
(00:25:57) Outro
Переглядів: 3 978

Відео

Gatling for JavaScript: The Ultimate Load Testing Tool Unveiled!
Переглядів 9673 місяці тому
Gatling JavaScript is here, and it's a game-changer! 🔥 In this video, we take a closer look at the JavaScript version of Gatling, designed to bring the power of performance testing to a wider audience. Gatling JavaScript combines the efficiency of Gatling with the simplicity of JavaScript, making it easier to integrate stress testing into your existing workflows. #PerformanceTesting #Gatling #S...
Introducing Karate: The ULTIMATE Test Automation Tool
Переглядів 9204 місяці тому
Karate is an incredible tool that enables you to combine API testing, Performance testing, UI testing and Mocking - all within a single framework. In this video, we'll have a hands on demo of setting up a Karate test automation project, then use the simple human readable Karate syntax to write some API tests against a web application. #Karate #APITesting #UITesting #PerformanceTesting #TestAuto...
What's New In Gatling Version 3.11? (WARNING: Breaking Changes!)
Переглядів 7795 місяців тому
Gatling version 3.11 features a bunch of new updates, including a few breaking changes that you'll want to look out for. The long awaited JavaScript version of Gatling is also finally here as well! #Gatling #LoadTesting #StressTesting #PerformanceTesting Consider joining the channel: www.youtube.com/@james-willett ▬▬▬▬▬▬ 🔗 Additional Info 🔗 ▬▬▬▬▬▬ 🔗 Gatling 3.11 Release Notes: docs.gatling.io/r...
How to Create Social Preview Cards in MkDocs Material
Переглядів 6 тис.Рік тому
Social cards with MkDocs Material can now be customised to looks entirely how you wish. This video shows you exactly how to build them from scratch. #MkDocs #Material #Documentation Consider joining the channel: www.youtube.com/@james-willett ▬▬▬▬▬▬ 🔗 Additional Info 🔗 ▬▬▬▬▬▬ 🔗 Initial MkDocs Material Setup Video: ua-cam.com/video/Q-YA_dA8C20/v-deo.html 🔗 MkDocs Material Documentation: squidfun...
How To Easily Create Stunning Screen Recordings With Screen Studio
Переглядів 5 тис.Рік тому
Learn how to record stunning screencasts on Mac with minimal effort using Screen Studio. #ScreenStudio #ScreenCasting Consider joining the channel: www.youtube.com/@james-willett ▬▬▬▬▬▬ 🔗 Additional Info 🔗 ▬▬▬▬▬▬ 🔗 Screen Studio homepage (affiliate): bit.ly/42E4Gzm ▬▬▬▬▬▬ 💰 Sponsorships 💰 ▬▬▬▬▬▬ If you are interested in sponsoring this channel, please contact me on one of the channels below 👇 ▬...
Platform Engineering Explained With Simple Terms In Just 10 Mins
Переглядів 793Рік тому
What is Platform Engineering, and how does it fit into the modern software development landscape? In this video, we'll look at a brief history of software development over the past 20 years and learn why Platform Engineering will become critical. #PlatformEngineering #SoftwareDevelopment #Agile #DevOps Consider joining the channel: www.youtube.com/@james-willett I'm speaking at PlatformCon 2023...
Gatling Load Testing - Ultimate Crash Course Tutorial For Beginners
Переглядів 25 тис.Рік тому
This short course gets you started writing Gatling load & stress testing scripts fast. No prior knowledge of Gatling required! #Gatling #StressTesting #LoadTesting Consider joining the channel: www.youtube.com/@james-willett ▬▬▬▬▬▬ 🚀 Gatling Courses 🚀 ▬▬▬▬▬▬ ➡ Gatling Fundamentals - Java Version: bit.ly/3XQnGIk ➡ Gatling Fundamentals - Scala Version: bit.ly/3WB2KUT ➡ Advanced Gatling for Web Ap...
How To Create STUNNING Code Documentation With MkDocs Material Theme
Переглядів 70 тис.Рік тому
🚨 THIS VIDEO IS OUT OF DATE - NEW VERSION FOR 2024 - ua-cam.com/video/xlABhbnNrfI/v-deo.html 🚨 #MkDocs #GithubPages Consider joining the channel: www.youtube.com/@james-willett ▬▬▬▬▬▬ 🔗 Additional Info 🔗 ▬▬▬▬▬▬ 🔗 GitHub Repo for this Video: github.com/james-willett/mkdocs-material-youtube-tutorial 🔗 MkDocs Material Theme: squidfunk.github.io/mkdocs-material/ 🔗 MkDocs Material Documentation: squ...
How To Use Mend Renovate For Automated Management Of Vulnerabilities In Code Projects
Переглядів 8 тис.Рік тому
How To Use Mend Renovate For Automated Management Of Vulnerabilities In Code Projects
How To Use ChatGPT To Write Gatling Stress Test Scripts (Must See)
Переглядів 3,2 тис.Рік тому
How To Use ChatGPT To Write Gatling Stress Test Scripts (Must See)
Gatling Java Version - Beginners Tutorial and Guide
Переглядів 7 тис.Рік тому
Gatling Java Version - Beginners Tutorial and Guide
6 ways Software Engineers can leverage ChatGPT
Переглядів 779Рік тому
6 ways Software Engineers can leverage ChatGPT
Gatling Test Reports - Beginners Tutorial
Переглядів 5 тис.4 роки тому
Gatling Test Reports - Beginners Tutorial
Run Gatling Tests from the CLI with Maven or Gradle
Переглядів 6 тис.4 роки тому
Run Gatling Tests from the CLI with Maven or Gradle
Gatling Load Simulation Design - Beginners Tutorial
Переглядів 6 тис.4 роки тому
Gatling Load Simulation Design - Beginners Tutorial
Gatling Feeders for Test Data - Beginners Tutorial
Переглядів 8 тис.4 роки тому
Gatling Feeders for Test Data - Beginners Tutorial
Gatling Tutorial for Beginners - Scripting Fundamentals
Переглядів 15 тис.4 роки тому
Gatling Tutorial for Beginners - Scripting Fundamentals
Gatling Recorder Tutorial using Chrome - for Windows or Mac
Переглядів 21 тис.4 роки тому
Gatling Recorder Tutorial using Chrome - for Windows or Mac
Gatling - using CSV Feeders to add Test Data
Переглядів 4,5 тис.6 років тому
Gatling - using CSV Feeders to add Test Data
Gatling - using JSON Path to extract Response Body
Переглядів 3,9 тис.6 років тому
Gatling - using JSON Path to extract Response Body
Gatling Introduction
Переглядів 41 тис.7 років тому
Gatling Introduction

КОМЕНТАРІ

  • @AndreiKatin
    @AndreiKatin 4 дні тому

    Super

  • @Justo-Mend
    @Justo-Mend 8 днів тому

    Nice video. Really well presented. Thanks!

  • @kapanadze
    @kapanadze 9 днів тому

    ❤❤❤❤❤

  • @ApxuBbI
    @ApxuBbI 12 днів тому

    Virtual environment for python is created, so if your loaded files will reside in project folder, and wont clutter APPDATA (Windows) ?

    • @james-willett
      @james-willett 12 днів тому

      Yes, when you create a Python virtual environment inside your project folder, it will isolate all the installed packages and dependencies within that environment. This means that the files related to the virtual environment (e.g., Python executables, pip, and any installed packages) will reside in the project folder itself, and nott clutter global directories like APPDATA on Windows.

  • @neo-mashiro
    @neo-mashiro 12 днів тому

    Thanks for the great video, this is really helpful. For the Github Actions though, I don't think the caching step is set up correctly because the ".cache" folder just doesn't exist. If you jump into the action logs, you will see something like this: Warning: Path Validation Error: Path(s) specified in the action for caching do(es) not exist, hence no cache is being saved.

    • @james-willett
      @james-willett 12 днів тому

      Thanks for commenting. I think the ".cache" folder gets created earlier in the video when we did `pip install `or `mkdocs build`

  • @tillcarlos664
    @tillcarlos664 14 днів тому

    Wow, I love this video style. It's well edited and well spoken!

    • @james-willett
      @james-willett 12 днів тому

      Thanks so much for this feedback - highly appreciated.

  • @alyonachmil9781
    @alyonachmil9781 15 днів тому

    Thanks. It was very useful.

  • @rijutsu
    @rijutsu 18 днів тому

    A quick note to say that I've spent the better part of the past three days using this video to build my own set of pages and I can't thank you enough. The presentation, the links, the code examples, the chapters/timestamps in the video, and just so much of this was wildly helpful. Thank you so much for your effort! :D

    • @james-willett
      @james-willett 15 днів тому

      Thanks for taking the time to write this comment. Lots more content planned ☺️

  • @mikeball4959
    @mikeball4959 19 днів тому

    Superb video, thank you. When I get to the last step though I'm getting Page not found on the URL rather than the documentation. Any ideas?

    • @james-willett
      @james-willett 15 днів тому

      Check the GitHub settings , maybe you missed setting to the new branch ?

  • @soymadip
    @soymadip 24 дні тому

    i wanna put the docs in a docs branch and wannna deploy from there. is this possible?

    • @james-willett
      @james-willett 12 днів тому

      Yes its possible. By default, MkDocs uses the gh-pages branch for deployment. However, you can change this behavior by specifying the remote-branch option in the mkdocs.yml configuration file or by passing it as a command-line argument. For example, if you want to deploy from the docs branch, you can run: mkdocs gh-deploy --remote-branch docs Make sure to also update the branch in the GitHub settings when you are configuring GitHub Pages

  • @CoolDownMati
    @CoolDownMati 25 днів тому

    great video!

  • @abepeterson
    @abepeterson 25 днів тому

    What setting do we implement so every time I push to github it stops resetting my custom URL! I have been trying for weeks, I even added the CNAME.txt to the docs directory and still, when I do a push it drops the custom URL. The CNAME folder shows the URL, but no resolution unless I go to the repo github page settings and set it again.

    • @james-willett
      @james-willett 12 днів тому

      Sorry to hear you are having this problem. It's hard for me to diagnose without seeing your repo, but theres a few things you might want to try: 1. Ensure the CNAME File is in the Correct Location The CNAME file should be in your source directory (e.g., docs/) so that it gets copied to the root of the built site during deployment. 2. Modify Your GitHub Actions or Deployment Script GitHub Actions might be overwriting or exclude the CNAME file during each deployment. You can modify your workflow to ensure that the CNAME file is always included in the deployment. You can add a step to ensure that the CNAME file is copied into the build output before deploying, e.g: jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout repository uses: actions/checkout@v2 - name: Set up Python uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies run: pip install mkdocs mkdocs-material - name: Build site run: mkdocs build - name: Add CNAME file run: echo "yourcustomdomain.com" > ./site/CNAME - name: Deploy to GitHub Pages run: mkdocs gh-deploy --force 3. Check GitHub Pages Settings Check your repository's GitHub Pages settings, Go to Settings > Pages. Make sure that under "Custom domain," your custom domain is listed and saved. Hope that helps...

  • @sivaprakash8375
    @sivaprakash8375 27 днів тому

    there is a certificate issue with gatling when trying to run the test.

  • @gabrielbronzattimoro7953
    @gabrielbronzattimoro7953 27 днів тому

    That is an incredible content 🎉 Thank you so much for sharing this with us!

  • @MillDora-i5g
    @MillDora-i5g Місяць тому

    Witting Park

  • @DorisAtwood-g7l
    @DorisAtwood-g7l Місяць тому

    Weimann Meadows

  • @TommyTammy-d9m
    @TommyTammy-d9m Місяць тому

    Schneider Ports

  • @Kerensky55
    @Kerensky55 Місяць тому

    Excellent video 👍👍

  • @MsJaneJack
    @MsJaneJack Місяць тому

    Thank you. Very useful video

  • @mreduar
    @mreduar Місяць тому

    Super video! Thanks for this!

  • @mdlsvensson
    @mdlsvensson Місяць тому

    Incredibly concise and well put together video. Thank a lot!

  • @VrejGaming
    @VrejGaming Місяць тому

    One of the best MkDocs tutorials I have watched! Incredibly helpful, thank you!

    • @james-willett
      @james-willett Місяць тому

      Appreciate that - thank you ! 🙏

  • @lockdown50559
    @lockdown50559 Місяць тому

    Man, you made this video just in time for me! I think that you are an amazing presenter.

    • @james-willett
      @james-willett Місяць тому

      Thanks - appreciate your feedback ☺️

  • @HKTECH-001
    @HKTECH-001 Місяць тому

    I really enjoyed your video! How can I insert pictures or videos into documents? Also, could you explain how to add a blog to it? I tried going through their official documentation on GitHub, but I found it overwhelming. Your teaching style is clear and easy to follow, and I appreciate how you explain things. It's very easy to understand. Please help me add pictures, videos, and hyperlinks to the documents? Also, I'm curious about how you added a thumbnail to your "Getting Started with Material for MkDocs" post.

  • @RonenSigan
    @RonenSigan Місяць тому

    How many levels can a ToC have (left pane navigation)? For example, can these amount of levels be supported: APIs -> Weather Forecast Requests-> Daily --> Centigrade Thanks

    • @james-willett
      @james-willett Місяць тому

      Good question - I’m pretty sure you can nest multiple times. Make sure you enable “navigation.sections” in your config . See squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections

  • @shadow_1363
    @shadow_1363 Місяць тому

    Great video, very helpful!

    • @james-willett
      @james-willett Місяць тому

      Glad to hear that! Thanks for letting me know :)

  • @Daniel-ops
    @Daniel-ops Місяць тому

    Thanks for the video James! just started with mkdocs to host my personal blog and loving it so far.

    • @james-willett
      @james-willett Місяць тому

      Great to hear! Please share a link , would love to take a look

  • @wondermannier4398
    @wondermannier4398 Місяць тому

    Great! I enjoyed this video to the point of watching it twice. It would be nice to see your video tutorials on stress and endurance testing using Gatling. Thanks

  • @james-willett
    @james-willett Місяць тому

    🧐 Transform your documentation with MkDocs and the Material theme! Follow this guide to publish your portal online in no time. Want more content like this? Let me know, and I'll dive deeper in future tutorials!

  • @francisxavier3890
    @francisxavier3890 Місяць тому

    Thanks; I liked the way you explained. I get this error when I tried it from my end: ERROR c.intuit.karate.core.FeatureParser - not a valid feature file: examples/puzzletosolve.feature - mismatched input 'w' expecting <EOF>

    • @james-willett
      @james-willett Місяць тому

      Thanks for the feedback. I'd need to see your code to debug the error, but it looks like you might have a typo in your feature file

  • @LifeCoachAbhi
    @LifeCoachAbhi 2 місяці тому

    Awesome video to get started on Gatling. Crisp and precise. Thanks a ton. 🙏

  • @jatlineur
    @jatlineur 2 місяці тому

    can i use itu for blogging?

    • @james-willett
      @james-willett Місяць тому

      Yes its amazing for a blog. Hoping to create a video for this soon.

  • @yulianneshev
    @yulianneshev 2 місяці тому

    Hello, the vide is really nice, I watched 2 times. What can I do when I want to create a performance test but in order to visit the website I need credentials? There is a certain page in the website which I want to test with a lot of users concurrently. I guess it would need authorization and token to be added somehow, maybe even more things.

    • @james-willett
      @james-willett Місяць тому

      Glad you enjoyed the video. Yes Gatling can handle all these things. Check my other video if you need help

  • @RomanDodin
    @RomanDodin 2 місяці тому

    A very good companion to the official docs. Kudos!

    • @james-willett
      @james-willett 2 місяці тому

      Thanks Roman - much appreciated :)

  • @marcusblackhall4306
    @marcusblackhall4306 2 місяці тому

    Great video. Thanks 👍

    • @james-willett
      @james-willett 2 місяці тому

      Glad you liked it! Appreciate the feedback - what else would you like to see covered?

  • @charlie3502
    @charlie3502 2 місяці тому

    Excellent tutorial, James. I am unable to see the dark mode toggle button on my mkdocs site. What might be the reason?

    • @james-willett
      @james-willett 2 місяці тому

      Thanks Charlie - glad it was helpful. Honestly I'm not sure without seeing your code. However, I am currently working on a brand new getting started video for MkDocs Material where I cover this, so following that might help. It should be out in a week or so.

  • @kannansingaravelu
    @kannansingaravelu 2 місяці тому

    how do I link a '.py' file to list the docstring using mkdocs. Also, how to rearrange the order of nav menus?

    • @james-willett
      @james-willett 2 місяці тому

      I'm not sure I understand the docstring question, could you elaborate? For reordering see if github.com/squidfunk/mkdocs-material/discussions/3482 is helpful

  • @bryceshirley9285
    @bryceshirley9285 3 місяці тому

    Thanks for your video! It was super helpful :) I've had issues rendering html... Do any of these features and plugins in the yml file cause issues when rendering images using html in your markdown files? <p align="center"> <img src="image1.png" alt="image 1" height="100"> <img src="image2.png" alt="image 2" height="100"> </p> I can't seem to get the above to render (the images are in the docs directly with the markdown file)

    • @james-willett
      @james-willett 2 місяці тому

      Thanks for the kind words! I'm not aware of any issues with regards to rendering and plugin to be honest... I'm actually working on an updated version of this tutorial that should be out in a next next or two - so I'll keep an eye out for any issues around this in the latest version of the plugins

  • @farkalitusman144
    @farkalitusman144 3 місяці тому

    Nice video and thanks James for your good effort.

    • @james-willett
      @james-willett 2 місяці тому

      Glad you enjoyed it - thanks for commenting :)

  • @mikedandreaChFC
    @mikedandreaChFC 3 місяці тому

    was this recorded with that tool? I have not seen how to make the camera fill the frame...

    • @james-willett
      @james-willett Місяць тому

      Partly yes, but I also used Premier Pro though for some of it

  • @papunmohanty5968
    @papunmohanty5968 3 місяці тому

    great setup, looks cool 😎 love to see how your day look like when you do your day work and also when you do recordings and operates those cool gadgets

    • @james-willett
      @james-willett 2 місяці тому

      Got it! Thanks for letting me know. I have the video planned in my pipeline amongst some other new projects :)

  • @Tamahome88
    @Tamahome88 3 місяці тому

    Hello there, I joined a new project and decided to use Gatling with JS for the load testing. It's a really interesting opportunity for testers, who are used to work with JS.

    • @james-willett
      @james-willett 2 місяці тому

      Good choice! Let me know how it goes!

  • @ProAttique
    @ProAttique 3 місяці тому

    I recently got screen studio. Overall its a great recorder but there are a few cons i identified. 1- no pause unpause shortcuts 2- no further shortcuts optimization 3- no camera adjustment with keyframes on different segments. For example, if i set cam position at one place then there is no option to move it to left or right or any other place during the entire recorded video 4- system audio mixing with external mic audio. No separate channels to record audio 5- rendering time is way longer than normal screen recorders such as OBS 6- editing timeline sometimes creates zoom in out problems 7- heats up even my mac m2 and takes huge part of RAM and GPU 8- no livestream options available 9- no option to remove silences filler words etc as it’s an editor too Good luck though it has kinda great features too

  • @_boris
    @_boris 3 місяці тому

    Got this recommended in my feed, awesome production quality, keep up the good work James In the meanwhile I’ll check out the other videos on the channel Appreciate your work!

    • @james-willett
      @james-willett 2 місяці тому

      Thanks Boris - really appreciate you taking the time to watch and comment. Anything in particular you would like to see covered?

  • @m.chowdhury4196
    @m.chowdhury4196 3 місяці тому

    Superb! Really liked that so much was covered in 20 minutes. Just a quick question - does the JavaScript version use more resources compared to the Scala version, for a relatively large test, say with 1000 vusers? Any info on the resource consumption will be appreciated.

    • @james-willett
      @james-willett 3 місяці тому

      Thanks for the feedback. So I asked the Gatling team this question around a month ago, and they didn’t yet have any profiling data to compare the versions . With that being said , the JS version is essentially a wrapper on top of the original Scala code , so I would expect the resource consumption to be similar

    • @m.chowdhury4196
      @m.chowdhury4196 3 місяці тому

      @@james-willett Thanks so much for your response! Great to know that resource consumption in the JS version is similar to the original Scala version

  • @waldo4815
    @waldo4815 3 місяці тому

    Great video as usual. Glad to see you're uploading again!

    • @james-willett
      @james-willett 3 місяці тому

      Thanks - really appreciate it . And im also pleased to be back uploading ☺️

  • @ashanberuwalage
    @ashanberuwalage 3 місяці тому

    Amazing tutorial James. 🎈 Clear explanation.

  • @james-willett
    @james-willett 3 місяці тому

    💡Gatling JavaScript is a game-changer for load testing! Let me know your thoughts on this video and what else you'd like me to explore!

  • @mrzkipr
    @mrzkipr 4 місяці тому

    this is amazing, non technical person would easily understand the code. Thanks James!

  • @ptrthomas
    @ptrthomas 4 місяці тому

    wow, this is great 🔥 thanks James !