A NextJS driven README website for project introduction use, simply display project related markdown files like: README.md
, CHANGELOG.md
, CODE_OF_CONDUCT.md
, etc.
blog pages comming soon...
- Standalone Next.js application which can be cusomized for your case
- A project doc generator using README.md and other .md files
- Builtin support for .mdx content generation
- Responsive layout for mobile screen
There is a starter prject using-optimus-readme
which demonstrated the usage.
please check it out
!
Deploy the example using Vercel:
How do I add more language highlighting support?
By default prism-react-renderer
only includes an arbitrary subset of the languages that Prism supports. You can add support for more by including their definitions from the main prismjs
package:
import Prism from "prism-react-renderer/prism";
(typeof global !== "undefined" ? global : window).Prism = Prism;
require("prismjs/components/prism-kotlin");
require("prismjs/components/prism-csharp");
How do I use my old Prism css themes?
prism-react-renderer
still returns you all proper className
s via the prop getters,
when you use it. By default however it uses its new theming system, which output a
couple of style
props as well.
If you don't pass theme
to the <Highlight />
component it will default to not
outputting any style
props, while still returning you the className
props, like
so:
<Highlight
{...defaultProps}
code={exampleCode}
language="jsx"
theme={undefined}
>
{highlight => null /* ... */}
</Highlight>
- Banner Image Photo by Benjamin Davies @unsplash
- Logo and fav Icons made by Freepik from flaticon
- Favicon Generator. For real.