docs: add static documentation website #112
Conversation
docs/README.md
Outdated
| The easiest and least intrusive way is to use docker. | ||
|
|
||
| ```shell | ||
| # Installation |
There was a problem hiding this comment.
not useful, image will be pulled anyway
There was a problem hiding this comment.
done: I deleted the unnecessary line.
| </div> | ||
| </section> | ||
| <section class="knl-snippet md-grid"> | ||
| <pre><code class="knl-snippet__code"><span class="instruction">from</span> transformers <span |
There was a problem hiding this comment.
we changed the way it works, need to change the example
There was a problem hiding this comment.
done: the snippet is iso with the readme file of kernl.
| @@ -0,0 +1,188 @@ | |||
| {% extends "main.html" %} | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
You are absolutely right. It's much less readable and accessible. But visually it becomes different.
I would rather readjust and have it validated by a feedback from the team. I note it and make an issue in this sense.
| {% extends "main.html" %} | ||
| {% block tabs %} | ||
| {{ super() }} | ||
| <style> |
There was a problem hiding this comment.
This is due to the context of Material for MkDocs. For styles to be applied, they must be at the bottom of the cascading.
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v1 | ||
| with: | ||
| # Upload entire repository |
There was a problem hiding this comment.
entire repository ? what to you mean
There was a problem hiding this comment.
done: upload entire static site
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url}} | ||
| runs-on: ubuntu-latest | ||
| steps: |
There was a problem hiding this comment.
no reference to /docs here ? @white-gorilla
This PR adds the static documentation site, customized with a landing page.
On this landing page, the Highlights section (benchmarks + schema) is missing.
Note: For the moment, I have left some things as comments in the configuration file.Reminder
docs/readme.md.Tested browsers
fix #113