In [ ]:
from IPython.display import Markdown
def add_meta(md, meta):
if meta: meta = "{" + meta + "}"
return md + meta
def img(fname, style="", height=None, relative=None, link=False):
meta = ""
if height:
if meta: meta += " "
meta += f"height={height}px"
if relative:
pos,px = relative
if style: style += " "
style += f"position:relative; {pos}: {px}px"
if style:
if meta: meta += " "
meta += f'style="{style}"'
res = f''
if link: res = f'[{res}](images/{fname})'
return add_meta(res, meta)
def btn(txt, link):
meta = '.btn-action-primary .btn-action .btn .btn-success .btn-lg role="button"'
return add_meta(f'[{txt}]({link})', meta)
def banner(txt, klass="", md=True):
res = f"::: {{.hero-banner {klass}}}\n\n{txt}\n\n:::\n"
if md: return Markdown(res)
print(res)
In [ ]:
banner(f"""
# <span style='color:#009AF1'>Create delightful software</span><br>with Jupyter Notebooks
### Write, test, document, and distribute software packages and technical articles — all in one place, your notebook.
{btn('Get started', 'getting_started.ipynb')}
{img('card.png', style="margin-top: 40px; margin-bottom: 40px", link=True)}
""", ".content-block")
Out[ ]:
::: {.hero-banner .content-block}
Create delightful software
with Jupyter Notebooks
Write, test, document, and distribute software packages and technical articles — all in one place, your notebook.¶
Get started{.btn-action-primary .btn-action .btn .btn-success .btn-lg role="button"}
{style="margin-top: 40px; margin-bottom: 40px"}
:::
In [ ]:
def industry(im): return f":::{{.g-col-12 .g-col-sm-6 .g-col-md-3}}\n{im}\n:::\n"
industries = '\n'.join([
industry(img('netflix.svg', height=26, relative=("top",1))),
industry(img('transform.svg', height=26, relative=("bottom",1))),
industry(img('outerbounds.svg', height=26, relative=("bottom",1))),
industry(img('novetta.svg', height=30, relative=("top",1))),
industry(img('amd.svg', height=22)),
industry(img('overstory.png', height=26)),
industry(img('bom.png', height=46, relative=("bottom",12))),
industry(img('lyft.svg', height=34)),
])
banner(f"""## <span style='color:#009AF1'>Trusted</span> in industry
::: {{.grid style="column-gap: 50px"}}
{industries}
:::
""", ".mid-content")
Out[ ]:
::: {.hero-banner .mid-content}
Trusted in industry¶
::: {.grid style="column-gap: 50px"}
:::{.g-col-12 .g-col-sm-6 .g-col-md-3}
{height=26px style="position:relative; top: 1px"}
:::
:::{.g-col-12 .g-col-sm-6 .g-col-md-3}
{height=26px style="position:relative; bottom: 1px"}
:::
:::{.g-col-12 .g-col-sm-6 .g-col-md-3}
{height=26px style="position:relative; bottom: 1px"}
:::
:::{.g-col-12 .g-col-sm-6 .g-col-md-3}
{height=30px style="position:relative; top: 1px"}
:::
:::{.g-col-12 .g-col-sm-6 .g-col-md-3}
{height=22px}
:::
:::{.g-col-12 .g-col-sm-6 .g-col-md-3}
{height=26px}
:::
:::{.g-col-12 .g-col-sm-6 .g-col-md-3}
{height=46px style="position:relative; bottom: 12px"}
:::
:::{.g-col-12 .g-col-sm-6 .g-col-md-3}
{height=34px}
:::
:::
:::
::: {.content-block}
In [ ]:
banner(f"""## <span style='color:#009AF1'>Exploratory programming</span><br>without compromise
### Traditional programming environments throw away the result of your exploration in REPLs or notebooks. nbdev makes exploration an integral part of your workflow, all while promoting software engineering best practices.
""")
Out[ ]:
::: {.hero-banner }
Exploratory programming
without compromise
Traditional programming environments throw away the result of your exploration in REPLs or notebooks. nbdev makes exploration an integral part of your workflow, all while promoting software engineering best practices.¶
:::
In [ ]:
def feature(im, desc):
return f"""::: {{.feature .g-col-12 .g-col-sm-6 .g-col-md-4}}
{img(im+'.svg')}
{desc}
:::
"""
features = '\n'.join([
feature('docs', 'Beautiful technical documentation and scientific articles with Quarto'),
feature('testing', 'Out-of-the-box continuous integration with GitHub Actions'),
feature('packaging', 'Publish code to PyPI and conda, and prose to GitHub Pages'),
feature('vscode', 'Two-way sync with your favourite IDEs'),
feature('jupyter', 'Write prose, code, and tests in notebooks — no context-switching'),
feature('git', 'Git-friendly notebooks: human-readable merge conflicts; no unwanted metadata')
])
In [ ]:
Markdown(f"""::: {{.grid .gap-4 style="padding-bottom: 60px"}}
{features}
:::
""")
Out[ ]:
::: {.grid .gap-4 style="padding-bottom: 60px"}
::: {.feature .g-col-12 .g-col-sm-6 .g-col-md-4}
Beautiful technical documentation and scientific articles with Quarto :::
::: {.feature .g-col-12 .g-col-sm-6 .g-col-md-4}
Out-of-the-box continuous integration with GitHub Actions :::
::: {.feature .g-col-12 .g-col-sm-6 .g-col-md-4}
Publish code to PyPI and conda, and prose to GitHub Pages :::
::: {.feature .g-col-12 .g-col-sm-6 .g-col-md-4}
Two-way sync with your favourite IDEs :::
::: {.feature .g-col-12 .g-col-sm-6 .g-col-md-4}
Write prose, code, and tests in notebooks — no context-switching :::
::: {.feature .g-col-12 .g-col-sm-6 .g-col-md-4}
Git-friendly notebooks: human-readable merge conflicts; no unwanted metadata :::
:::
:::
::: {.mid-content}
In [ ]:
banner("## Here's what experts are saying")
Out[ ]:
In [ ]:
def testm(im, nm, detl, txt):
return f"""::: {{.testimonial .g-col-12 .g-col-md-6}}
{img(im, link=True)}
# {nm}
## {detl}
### {txt}
:::
"""
testms = '\n'.join([
testm('chris-lattner.png', 'Chris Lattner', 'Inventor of Swift and LLVM',
'I really do think [nbdev] is a huge step forward for programming environments.'),
testm('fernando-pérez.jpeg', 'Fernando Pérez', 'Creator of Jupyter',
'[nbdev] should be celebrated and used a lot more — I have kept a tab with your original nbdev blog post open for months in Chrome because of how often I refer to it and point others to this work.'),
testm('david-berg.jpeg', 'David Berg', 'Software Engineer, Netflix',
'Prior to using nbdev, documentation was the most cumbersome aspect of our software development process… Using nbdev allows us to spend more time creating rich prose around the many code snippets guaranteeing the whole experience is robust.<br><br>nbdev has turned what was once a chore into a natural extension of the notebook-based testing we were already doing.'),
testm('erik-gaasedelen.jpeg', 'Erik Gaasedelen', 'Software Engineer, Lyft',
'I use this in production at my company. It’s an awesome tool… nbdev streamlines everything so I can write docs, tests, and code all in one place… The packaging is also really well thought out.<br><br>From my point of view it is close to a Pareto improvement over traditional Python library development.'),
testm('roxanna-pourzand.jpeg', 'Roxanna Pourzand', 'Product Manager, Transform',
'We’re so excited about using nbdev. Our product is technical so our resulting documentation includes a lot of code-based examples. Before nbdev, we had no way of maintaining our code examples and ensuring that it was up-to-date for both command inputs and outputs. It was all manual. With nbdev, we now have this under control in a sustainable way. Since we’ve deployed these docs, we also had a situation where we were able to identify a bug in one of our interfaces, which we found by seeing the error that was output in the documentation.'),
testm('hugo-bowne-anderson.jpeg', 'Hugo Bowne-Anderson', 'Head of Developer Relations, Outerbounds',
'Nbdev has transformed the way we write documentation. Gone are the days of worrying about broken code examples when our API changes or due to human errors associated with copying & pasting code into markdown files. The authoring experience of nbdev is also powerful, allowing us to write prose and live code in a unified interface, which allows more experimentation with technical content. On top of this, nbdev allows us to include unit tests in our documentation which mitigates the burden of maintaining the docs over time.')
])
In [ ]:
Markdown(f"""::: {{.content-block .grid .gap-4}}
{testms}
:::
""")
Out[ ]:
::: {.content-block .grid .gap-4}
::: {.testimonial .g-col-12 .g-col-md-6}
Chris Lattner¶
Inventor of Swift and LLVM¶
I really do think [nbdev] is a huge step forward for programming environments.¶
:::
::: {.testimonial .g-col-12 .g-col-md-6}
Fernando Pérez¶
Creator of Jupyter¶
[nbdev] should be celebrated and used a lot more — I have kept a tab with your original nbdev blog post open for months in Chrome because of how often I refer to it and point others to this work.¶
:::
::: {.testimonial .g-col-12 .g-col-md-6}
David Berg¶
Software Engineer, Netflix¶
Prior to using nbdev, documentation was the most cumbersome aspect of our software development process… Using nbdev allows us to spend more time creating rich prose around the many code snippets guaranteeing the whole experience is robust.
nbdev has turned what was once a chore into a natural extension of the notebook-based testing we were already doing.
:::
::: {.testimonial .g-col-12 .g-col-md-6}
Erik Gaasedelen¶
Software Engineer, Lyft¶
I use this in production at my company. It’s an awesome tool… nbdev streamlines everything so I can write docs, tests, and code all in one place… The packaging is also really well thought out.
From my point of view it is close to a Pareto improvement over traditional Python library development.
:::
::: {.testimonial .g-col-12 .g-col-md-6}
Roxanna Pourzand¶
Product Manager, Transform¶
We’re so excited about using nbdev. Our product is technical so our resulting documentation includes a lot of code-based examples. Before nbdev, we had no way of maintaining our code examples and ensuring that it was up-to-date for both command inputs and outputs. It was all manual. With nbdev, we now have this under control in a sustainable way. Since we’ve deployed these docs, we also had a situation where we were able to identify a bug in one of our interfaces, which we found by seeing the error that was output in the documentation.¶
:::
::: {.testimonial .g-col-12 .g-col-md-6}
Hugo Bowne-Anderson¶
Head of Developer Relations, Outerbounds¶
Nbdev has transformed the way we write documentation. Gone are the days of worrying about broken code examples when our API changes or due to human errors associated with copying & pasting code into markdown files. The authoring experience of nbdev is also powerful, allowing us to write prose and live code in a unified interface, which allows more experimentation with technical content. On top of this, nbdev allows us to include unit tests in our documentation which mitigates the burden of maintaining the docs over time.¶
:::
:::
:::
In [ ]:
banner(f"""
## Get started in seconds
{btn('Install nbdev', 'getting_started.ipynb')}
""", '.content-block style="margin-top: 40px"')
Out[ ]:
::: {.hero-banner .content-block style="margin-top: 40px"}
Get started in seconds¶
Install nbdev{.btn-action-primary .btn-action .btn .btn-success .btn-lg role="button"}
:::
::: {.footer .content-block} Copyright © 2019 onward fast.ai, Inc. All rights reserved. :::