展示区
展示区用于向文档学习者演示你的demo运行结果。
两种展示模式
Sutras提供了两种demo展示模式:终端模式、界面模式。
终端模式
如果你的library是js工具类库,那么通过js console
输出你的library运行结果可能更合适便捷。详见终端模式
界面模式
如果你的library是前端组件、Hooks,或者样式库,那么通过可视化的UI界面,向学习者展示你的library运行结果是很好的选择。
界面模式也包含终端模式的功能,方便你的文档学习者在合适的位置输出demo内部状态。详见界面模式
SSR渲染
Sutras提供了SSR/CSR切换,如果你的libary支持服务端渲染(SSR),Sutras可以让你的文档学习者在任何模式下进行REPL操作,详见服务端渲染。
设备尺寸
Sutras在界面模式下提供了设备尺寸切换以及设备旋转功能,如果你的library使用场景是移动端,那么这个功能会对你很有帮助,详见设备尺寸。
风格样式
Sutras针对展示区提供了必要的风格配置,如:
紧凑风格(compact):展示区默认是有边距的,如果你的demo要展示全局的Layout,那么紧凑风格更适合你。
背景色:展示区背景色默认跟随主题发生变化,如果你的demo需要在特殊背景颜色下展示(如ghost
),可以通过配置项为demo设置特殊背景。
详见风格样式
错误提示
Sutra在展示区将对demo的运行时错误给予提示,详见运行时错误