|
349 | 349 | "git add .\n", |
350 | 350 | "git commit -m'Initial commit'\n", |
351 | 351 | "git push\n", |
352 | | - "```" |
| 352 | + "```\n", |
| 353 | + "\n", |
| 354 | + "\n", |
| 355 | + "### Enable GitHub Pages\n", |
| 356 | + "\n", |
| 357 | + "You need to enable GitHub Pages 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\".\n", |
| 358 | + "\n", |
| 359 | + "It should look similar to this after you click \"Save\":\n", |
| 360 | + "\n", |
| 361 | + "{.pb-2 fig-align=\"center\" .border .rounded .shadow-sm}" |
353 | 362 | ] |
354 | 363 | }, |
355 | 364 | { |
356 | 365 | "cell_type": "markdown", |
357 | 366 | "metadata": {}, |
358 | 367 | "source": [ |
359 | | - "It's time to see all of the goodies nbdev gives you!" |
| 368 | + "Now it's time to see all of the goodies nbdev gives you!" |
360 | 369 | ] |
361 | 370 | }, |
362 | 371 | { |
|
432 | 441 | "cell_type": "markdown", |
433 | 442 | "metadata": {}, |
434 | 443 | "source": [ |
435 | | - "nbdev hosts your docs on GitHub Pages---an excellent (and free!) way to host websites. \n", |
436 | | - "\n", |
437 | | - "#### Enabling GitHub Pages\n", |
438 | | - "\n", |
439 | | - ":::{.callout-important}\n", |
440 | | - "\n", |
441 | | - "##### Enabling GitHub Pages Is Not Required For Everyone\n", |
442 | | - "\n", |
443 | | - "nbdev makes a best effort to automatically enable GitHub Pages for you, however, there some cases where this is not possible such as private repos or where your organization's permissions are restricted. If you are having trouble seeing your site, we suggest checking if Pages are enabled for your repo by following the below instructions.\n", |
444 | | - "\n", |
445 | | - "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\".\n", |
446 | | - "\n", |
447 | | - "\n" |
448 | | - ] |
449 | | - }, |
450 | | - { |
451 | | - "cell_type": "markdown", |
452 | | - "metadata": {}, |
453 | | - "source": [ |
454 | | - "It should look similar to this after you click \"Save\":" |
455 | | - ] |
456 | | - }, |
457 | | - { |
458 | | - "cell_type": "markdown", |
459 | | - "metadata": {}, |
460 | | - "source": [ |
461 | | - "{.pb-2 fig-align=\"center\" .border .rounded .shadow-sm}" |
| 444 | + "nbdev hosts your docs on GitHub Pages---an excellent (and free!) way to host websites. " |
462 | 445 | ] |
463 | 446 | }, |
464 | 447 | { |
465 | 448 | "cell_type": "markdown", |
466 | 449 | "metadata": {}, |
467 | 450 | "source": [ |
468 | | - ":::\n", |
469 | | - "\n", |
470 | | - "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.\n", |
471 | | - "\n" |
| 451 | + "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." |
472 | 452 | ] |
473 | 453 | }, |
474 | 454 | { |
|
0 commit comments