|
250 | 250 | "\n", |
251 | 251 | "#### Try GitHub's powerful CLI\n", |
252 | 252 | "\n", |
253 | | - "GitHub's web interface is a great way to get started. As you grow more experienced, you might want to explore the CLI (command line interface). We often prefer to use command line tools for repetitive tasks where we're likely to make mistakes. Having those tasks written as small scripts in your terminal means that you can repeat them with little effort.\n", |
| 253 | + "GitHub's web interface is a great way to get started. As you grow more experienced, you might want to explore [the GitHub CLI](https://github.com/cli/cli) (command line interface). We often prefer to use command line tools for repetitive tasks where we're likely to make mistakes. Having those tasks written as small scripts in your terminal means that you can repeat them with little effort.\n", |
254 | 254 | "\n", |
255 | 255 | ":::" |
256 | 256 | ] |
|
432 | 432 | "cell_type": "markdown", |
433 | 433 | "metadata": {}, |
434 | 434 | "source": [ |
435 | | - "nbdev hosts your docs on GitHub Pages---an excellent (and free!) way to host websites." |
| 435 | + "nbdev hosts your docs on GitHub Pages---an excellent (and free!) way to host websites. nbdev automatically enables GitHub Pages when you create a nbdev-enabled GitHub repo." |
436 | 436 | ] |
437 | 437 | }, |
438 | 438 | { |
439 | 439 | "cell_type": "markdown", |
440 | 440 | "metadata": {}, |
441 | 441 | "source": [ |
442 | | - "You can enable it for your repo by clicking on the \"Settings\" tab near the top-right of your repo page, then \"Pages\" on the left, then setting the \"Branch\" to \"gh-pages\", and finally clicking \"Save\"." |
| 442 | + "By default, your docs should be available at: `https://{user}.github.io/{repo}`. For example, you can view `fastai`'s `nbdev-hello-world` docs at <https://fastai.github.io/nbdev-hello-world>:" |
443 | 443 | ] |
444 | 444 | }, |
445 | 445 | { |
446 | 446 | "cell_type": "markdown", |
447 | 447 | "metadata": {}, |
448 | 448 | "source": [ |
449 | | - "::: {.callout-note}\n", |
450 | | - "\n", |
451 | | - "nbdev uses GitHub Pages by default because its easily accessible, however you can use any host you like.\n", |
452 | | - "\n", |
453 | | - ":::" |
454 | | - ] |
455 | | - }, |
456 | | - { |
457 | | - "cell_type": "markdown", |
458 | | - "metadata": {}, |
459 | | - "source": [ |
460 | | - "It should look similar to this after you click \"Save\":" |
461 | | - ] |
462 | | - }, |
463 | | - { |
464 | | - "cell_type": "markdown", |
465 | | - "metadata": {}, |
466 | | - "source": [ |
467 | | - "{.pb-2 fig-align=\"center\" .border .rounded .shadow-sm}" |
468 | | - ] |
469 | | - }, |
470 | | - { |
471 | | - "cell_type": "markdown", |
472 | | - "metadata": {}, |
473 | | - "source": [ |
474 | | - "Head back to GitHub Actions and you should see a new workflow run: \"pages build and deployment\". As the name says, this workflow deploys your website contents to GitHub Pages." |
475 | | - ] |
476 | | - }, |
477 | | - { |
478 | | - "cell_type": "markdown", |
479 | | - "metadata": {}, |
480 | | - "source": [ |
481 | | - "{fig-align=\"center\" .border .rounded .shadow-sm}" |
482 | | - ] |
483 | | - }, |
484 | | - { |
485 | | - "cell_type": "markdown", |
486 | | - "metadata": {}, |
487 | | - "source": [ |
488 | | - "Wait for the workflow run to complete, then open your website. By default it should be available at: `https://{user}.github.io/{repo}`. For example, you can view `fastai`'s `nbdev-hello-world` docs at <https://fastai.github.io/nbdev-hello-world>." |
| 449 | + "{fig-align=\"center\" .border .rounded .shadow-sm}" |
489 | 450 | ] |
490 | 451 | }, |
491 | 452 | { |
492 | 453 | "cell_type": "markdown", |
493 | 454 | "metadata": {}, |
494 | 455 | "source": [ |
495 | | - "{fig-align=\"center\" .border .rounded .shadow-sm}" |
| 456 | + "::: {.callout-note}\n", |
| 457 | + "\n", |
| 458 | + "nbdev uses GitHub Pages by default because its easily accessible. However, you can use any host you like. The files for the static site are located in a local `/_docs` directory at the root of your repository after running the command `nbdev_docs` . This directory is not checked into git and is ignored by `.gitignore`, but you can use these files to deploy to any platform you want.\n", |
| 459 | + "\n", |
| 460 | + ":::" |
496 | 461 | ] |
497 | 462 | }, |
498 | 463 | { |
|
0 commit comments